JOSS REVIEW: clarify additional params

miykael / atlasreader

Python interface for generating coordinate tables and region labels from statistical MRI images

BSD 3-Clause "New" or "Revised" License

90 stars 31 forks source link

JOSS REVIEW: clarify additional params #103

Closed andrewheusser closed 5 years ago

andrewheusser commented 5 years ago

The additional parameters API documentation section lays out the API for create_output, but as it reads, it seems like the documentation is describing a function called atlasreader. I'd suggest replacing atlasreader at the top with atlasreader.create_output or just create_output.

miykael commented 5 years ago

You're right. Using atlasreader for the terminal and python implementation is not correct. I've repaced atlasreader with "AtlasReader" in most parts and wrote atlasreader.create_output where you suggested.

See https://github.com/miykael/atlasreader/pull/107/commits/8b42ce19440b1e28be462398b5b5ef8206b789a4.

andrewheusser commented 5 years ago

👍