Documentation to miget_dimension_sampling_flag is wrong - Githubissues

BIC-MNI / libminc

libminc is the core library and API of the MINC toolkit

Other

19 stars 29 forks source link

Documentation to miget_dimension_sampling_flag is wrong #78

Closed vfonov closed 6 years ago

vfonov commented 8 years ago

Documentation says: miget_dimension_sampling_flag returns True if dimension is regularly sampled, however https://github.com/BIC-MNI/libminc/blob/develop/libsrc2/dimension.c#L1111 returns True if dimension is irregularly sampled

same goes for https://github.com/BIC-MNI/libminc/blob/develop/libsrc2/dimension.c#L1124

rdvincent commented 8 years ago

Fixed doc in wikibooks here:

https://en.wikibooks.org/wiki/MINC/SoftwareDevelopment/MINC2.0_Application_Programmers_Interface#miget_dimension_sampling_flag.2Fmiset_dimension_sampling_flag