Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added 1 liners, explaining the description for freqdim, phasedim and slicedim nifti functions. #73

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

divital-coder
Copy link

No description provided.

@Tokazama
Copy link
Member

Would these be better to have in the doc strings themselves?

@divital-coder
Copy link
Author

Is that something not generally an ideal thing to do ? I just added a quick little liner to explain a bit, it most likely resembled me to be a documentation doc, so i just added a one liner there.

@Tokazama
Copy link
Member

I don't know if there is a hard and fast rule for this, but I usually put those sorts of comments in the docstrings so that they may be found in the REPL and manual. If I put things directly in a package manual it's usually for the purpose of describing a theme between multiple related methods for a given concept. For example this provides a lot of REPL accesible info pulled together by a bit of organization and a brief explanation of common concept.

@divital-coder
Copy link
Author

Right, seems like the latter is the more ideal approach to this.

@Tokazama
Copy link
Member

Right, seems like the latter is the more ideal approach to this.

If this adds any helpful info that isn't present in the docstrings perhaps add it there. Any help is greatly appreciated!

@divital-coder
Copy link
Author

ok will do that , thanks for guiding me in the right direction :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants