added example to docstring, removed reference to annotations #468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kohlerca
approved these changes
Apr 11, 2022
Kleinjohann
reviewed
Apr 11, 2022
| >>> import quantities as pq | ||
| >>> from elephant import conversion | ||
| >>> | ||
| >>> times = (np.arange(10) + np.random.uniform(size=10)) * pq.ms |
There was a problem hiding this comment.
Without a fixed seed this will fail when being run as a doctest since the result will change every time.
What's our policy for these examples? Should they work as doctests?
I guess that would help to keep the examples up to date, when running this I noticed that a few other examples in this file currently fail as well.
There was a problem hiding this comment.
Hey,
thanks for catching this, I fully agree, running doctests is helpful. So far it seems there is no policy regarding this, in the following the result of a doctest run for elephant:
pytest elephant --doctest-modules --ignore=elephant/test
========================================= test session starts ==================================================
platform linux -- Python 3.8.10, pytest-7.1.1, pluggy-1.0.0
collected 70 items
elephant/cell_assembly_detection.py F [ 1%]
elephant/change_point_detection.py FF [ 4%]
elephant/conversion.py FF..F [ 11%]
elephant/cubic.py F [ 12%]
elephant/datasets.py F [ 14%]
elephant/kernels.py . [ 15%]
elephant/phase_analysis.py F [ 17%]
elephant/signal_processing.py FF.F.FF [ 27%]
elephant/spade.py FF [ 30%]
elephant/spectral.py FF [ 32%]
elephant/spike_train_correlation.py FFFF. [ 40%]
elephant/spike_train_dissimilarity.py .. [ 42%]
elephant/spike_train_generation.py ....... [ 52%]
elephant/spike_train_surrogates.py FFF.. [ 60%]
elephant/spike_train_synchrony.py F [ 61%]
elephant/sta.py FF [ 64%]
elephant/statistics.py F..F....F [ 77%]
elephant/unitary_event_analysis.py F.FFFFFF [ 88%]
elephant/utils.py .. [ 91%]
elephant/waveform_features.py .. [ 94%]
elephant/asset/asset.py F [ 95%]
elephant/causality/granger.py F [ 97%]
elephant/gpfa/gpfa.py F [ 98%]
elephant/spade_src/fast_fca.py F [100%]
Lets discuss this, if doctests become mandatory, the above failed tests have to be fixed.
There was a problem hiding this comment.
fixed, see 232dcb0
Moritz-Alexander-Kern
added
the
documentation
Moritz-Alexander-Kern
deleted the
fix/discretise_spiketimes_docstring_behavior
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses Issue #464.
Changes: