search

fedora-python / pyp2rpm

Tool to convert a package from PyPI to RPM SPECFILE or to generate SRPM.
MIT License
128 stars 39 forks source link

man page for pyp2rpm #52

Closed rsuste closed 8 years ago

hroncok commented 8 years ago

Thanks for contributing.

Did you just write it in groff syntax or used some tool to generate it? It would be better to generate it, so it is not out of date soon.

rsuste commented 8 years ago

I wrote it in groff. Do you want it remake to Markdown or something other? Dne 25.5.2016 12:03 napsal uživatel "Miro Hrončok" <notifications@github.com

:

Thanks for contributing.

Did you just write it in groff syntax or used some tool to generate it? It would be better to generate it, so it is not out of date soon.

— You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub https://github.com/fedora-python/pyp2rpm/pull/52#issuecomment-221528950

hroncok commented 8 years ago

Not really, that would keep the problem. I was thinking generating it from the --help or something like that.

xsuchy commented 8 years ago

@hroncok I advised @RadimS97 to not generate it from --help as he wrote there more information than is available in --help output. E.g. Example section.

hroncok commented 8 years ago

And that's a good thing, but I'm afraid that the manpage will get outdated, so I'm thinking if there is a way to keep it up to date automatically somehow, but maybe I'm just overthinking it.

xsuchy commented 8 years ago

but maybe I'm just overthinking it.

:) Most of the projects have man page as separate file. And yes, it is one more thing to think about when you add feature/option that you need to write up documentation. But that is life and it happen when some project grown up.

mcyprian commented 8 years ago

@hroncok Do you have some more comments to this? Can I merge this PR now?

hroncok commented 8 years ago

I've added 2 inline comments, no response, feel free to consider them irrelevant and marge anyway, or change it after the merge.