search

JuliaNeuroscience / NIfTI.jl

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

Add docstrings for exported functions and types #59

Closed clin045 closed 2 years ago

clin045 commented 2 years ago

Added docstrings for the exported functions and types. This should make the package a bit more friendly to use, since currently the only way to access much of the documentation is by looking at the source comments.

clin045 commented 2 years ago

Is this project still active?

korbinian90 commented 2 years ago

I like these docstrings, can someone help with this? @Tokazama @timholy

clin045 commented 2 years ago

@timholy Thanks for the review! Julia is such a great language for neuroimaging work, and I'd love to help grow the ecosystem.

Tokazama commented 2 years ago

How often are people actively mutating fields in the header? I'd prefer that users not muck around with the header unless they really know what is going on and I'd like to just remove this type and attach an immutable header to Metadata.MetaArray.