On 2018-02-25 01:33:45, Adam Borowski wrote:
> Package: undertime
> Version: 1.1.0
> Severity: normal
>
> Hi!
> As "undertime" is a command-line program that requires arguments to do
> anything useful, some description of how to use it would be required.
>
> Shipping such documentation as a man page would be greatly preferred
> -- and there's no other docs in the package anyway.
There should be a README file in the package, and there's inline help
with the program with the `--help` flag.
What, in particular, would you like to see in the manpage? This would
help in writing one (and I would welcome patches that would create one
as well). If there's enough interest, I would write this as Sphinx
documentation and make that generate the manpage, which seems the
shortest path between a simple text format (rst) and the mangled mess of
backslashes that is manpage format. ;)
Obviously, if someone wants to undertake writing the manpage directly, I
have no objection of course.
A.
--
Les écrivains qui ont recours à leurs doigts pour savoir s'ils ont leur
compte de pieds ne sont pas des poètes, ce sont des dactylographes.
- Léo Ferré, "Préface"
