search

Donders-Institute / multiecho

Combine multiple-echoes from a multi-echo BOLD fMRI acquisition.
Apache License 2.0
6 stars 2 forks source link

Interest in maintaining a man page? #18

Closed musicinmybrain closed 1 year ago

musicinmybrain commented 1 year ago

I’m preparing to package this for Fedora Linux as a dependency for https://github.com/Donders-Institute/bidscoin.

We always like to have man pages for executables when possible. Sometimes help2man can generate something decent. In this case, the result would be mostly legible, but it doesn’t do a great job with the examples. I plan to use the --help output of mecombine to write a man page in groff_man(7) format by hand.

Is there any interest in keeping such a man page upstream? The Python ecosystem doesn’t really have a way to install man pages, but shipping a man page in the sdist would make it available to other distribution packagers, at least.

If this is of interest, I’m happy to offer a PR adding a man page mecombine.1 in the top-level directory and adding it to MANIFEST.in. Otherwise, I’ll just maintain the man page downstream.

marcelzwiers commented 1 year ago

That sounds great and that's certainly an incentive for me to bring the multiecho library up to standards. Any PR is of course more than welcome :-).

marcelzwiers commented 1 year ago

Is this of any use? I've never build manpages, but it seems to convert python's argparse arguments to a manpage? https://pypi.org/project/argparse-manpage/

musicinmybrain commented 1 year ago

Is this of any use? I've never build manpages, but it seems to convert python's argparse arguments to a manpage? https://pypi.org/project/argparse-manpage/

Hmm, it might be! I’ll take a look at it and see if it’s easy to incorporate. It’s always nice to reduce duplication.

marcelzwiers commented 1 year ago

I think Arch and Ubuntu use it also... (see e.g. https://man.archlinux.org/man/argparse-manpage.1.en)