Make documentation/docstrings testable #1035
Merged
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
Collaborator
eleftherioszisis
commented
May 10, 2022
•
eleftherioszisis
commented
- Turn most of code snippets into testable code.
- sphinx doctest checks docstrings and documentation for testable code
eleftherioszisis
requested review from
mgeplf,
adrien-berchet and
GianlucaFicarelli
and removed request for
mgeplf
eleftherioszisis
force-pushed
the
zisis/doctest
branch
from
4f763fb
to
fc48c28
Compare
eleftherioszisis
force-pushed
the
zisis/doctest
branch
from
fc48c28
to
d6da37d
Compare
Codecov Report
@@ Coverage Diff @@
## v4 #1035 +/- ##
======================================
Coverage ? 100.00%
======================================
Files ? 35
Lines ? 2469
Branches ? 0
======================================
Hits ? 2469
Misses ? 0
Partials ? 0 |
eleftherioszisis
force-pushed
the
zisis/doctest
branch
from
ccb879d
to
7deb84e
Compare
|
Are there any further comments on this, or may I merge it? |
|
LGTM |
Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
Co-authored-by: Adrien Berchet <adrien.berchet@gmail.com>
adrien-berchet
approved these changes
Jun 7, 2022
eleftherioszisis
pushed a commit
that referenced
this pull request
May 14, 2024
* Mixed subtree processing (#981) * Refactor tests for test_mixed.py (#1027) * Remove deprecated modules and functions/classes & warnings (#1026, #1032) * Use readonly morphio Morphology by default (#979) * Morphology level radial distance features use the soma as reference point (#1030) * Expose subtree processing from the morph_stats api (#1034) * Remove pyXX prefix for lint, docs, and coverage (#1038) * Fix tutorials and add tutorial testenv (#1039) * Add isort for formatting/linting (#1040) * Add testing of example scripts (#1041) * Make documentation/docstrings testable (#1035) * Add black to neurom, format everything, and add to lint (#1042) * Fix load_morpholgies to always resolve paths (#1047) * allow Morphology objects to be either mut or immut (#1049) * Replace iter_* methods by properties in core objects and improve iter_segments (#1054) * Decouple Morphology constructor from io (#1120) * Move soma methods to functions (#1118)
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.