DOC: Fix Docstring Rendering and Typos #463
Merged
Conversation
This file contains hidden or 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
- Fix docstrings for dsl.py.
- Fix docstrings for storage.py. - Use code-blocks for json.
- Exclude requirements.txt from conf.py.
- Fix hyperlinks in storage.py.
shaneahmed
changed the title
Codecov Report
@@ Coverage Diff @@
## develop #463 +/- ##
========================================
Coverage 98.63% 98.63%
========================================
Files 60 62 +2
Lines 5934 5936 +2
Branches 1056 1032 -24
========================================
+ Hits 5853 5855 +2
Misses 69 69
Partials 12 12
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
- Fix indentation for bullet list in wsireader.py.
- Fix underline for headings.
- Fix GitHub links.
- Fix indentation for bullet list.
- Fix indentation for bullet list in `env_detection.py`.
- Fix indentation for bullet list in `transforms.py`.
- Fix indentation for bullet list in `visualization.py`.
- Fix indentation for bullet list in `hovernetplus.py`.
- Fix indentation for bullet list in `hovernetplus.py`.
- Fix indentation for bullet list in `unet.py`.
- Fix indentation for bullet list in `patch_predictor.py`.
- Fix indentation for bullet list in `patch_predictor.py`.
- Fix indentation for bullet list in `semantic_segmentor.py`.
- Fix indentation for bullet point list in patchextraction.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Refactor dataset/abc to dataset/dataset_abc.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Fix indents for bullet points list in graph.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Fix indents for bullet points list in wsi_registration.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Fix indents for bullet points list in stainnorm.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Fix typo in stainnorm.py. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Intersphinx mapping torch. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- intersphinx mapping.
- Fix typos except models. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Remove unnecessary import. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Remove unnecessary import. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Remove unnecessary import. Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Fix typos Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Class attributes should be initialised in __init__ Signed-off-by: Shan E Ahmed Raza <[email protected]>
- Update requirements.txt Signed-off-by: Shan E Ahmed Raza <[email protected]>
shaneahmed
commented
Sep 9, 2022
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.
code-blockdirective for json.requirements.txtfrom sphinx build.Link for readthedocs: https://tia-toolbox.readthedocs.io/en/doc-fix-docstring-rendering/