1. Ned Batchelder
  2. coverage.py
  3. Issues
Issue #260 resolved

Unix manpage for command

Ben Finney
created an issue

Please distribute a Unix manpage for the ‘coverage’ command.

The manpage should follow the expected structure of other command manpages on a Unix-like system, allowing the command reference to be found in the standard location.

Comments (9)

  1. Ned Batchelder repo owner

    In all of my experience with Python kits, I have never seen something like this. Have I been overlooking things? Also, am I right in assuming that all I have to do is keep this in my source tree? Or it has to go in the Python source kit? Or what?

  2. Ben Finney reporter

    A manpage (manual page) is the standard way to document commands on Unix. I don't know how often Python distributions include manpages for their commands. It is helpful to OS package maintainers to have manpages as part of the upstream documentation.

    Since Coverage is generally useful, I am proposing that the ‘coverage’ command have a manpage in the Coverage documentation, tracked in VCS and updated in step when the command-line interface changes.

  3. Ned Batchelder repo owner

    I'm asking for specifics. What precisely do you want me to do? I think it is this: put python-coverage.1.txt into the docs directory of the repo. Anything else?

  4. Ben Finney reporter

    Thanks.

    In answer to your question on specifics: Ideally, the manual page document (which is in reStructuredText document for editing) would be kept up to date along with the other documentation in the repository and release tarballs.

  5. Log in to comment