search

JuliaNeuroscience / NIfTI.jl

Julia module for reading/writing NIfTI MRI files
Other
74 stars 34 forks source link

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

Open divital-coder opened 8 months ago

Tokazama commented 8 months ago

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

divital-coder commented 8 months ago

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 commented 8 months ago

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 commented 8 months ago

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

Tokazama commented 8 months ago

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 commented 8 months ago

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