Documentation update #184
Merged
Documentation update #184
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
for more information, see https://pre-commit.ci
|
@satra not sure why all test are failing for this pr. I have just pushed documentation changes that too in spatial transforms. |
can you fix this separately in a different PR |
|
More documentation changes coming. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
@satra this is ready to go! |
satra
requested changes
Dec 6, 2021
Co-authored-by: Satrajit Ghosh <[email protected]>
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
satra
requested changes
Dec 18, 2021
There was a problem hiding this comment.
The docstrings aren't consistent throughout yet.
- docstrings should begin with a single line summary. however, some are indented into the second line (https://www.python.org/dev/peps/pep-0257/)
- some docstrings say parameters and others say args
- some don't have newlines between texts and sections.
i was going to merge it, but i think it's better if we clean up all the changes before we merge.
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
@satra, please let me know if this needs a fix. thanks. |
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.
Types of changes
Summary
This PR is intended for documentation update of nobrainer functionalities.
Checklist
Acknowledgment