Opened 8 years ago

Closed 8 years ago

#2309 defect closed fixed (fixed)

trial man page incorrectly explains --coverage behaviour

Reported by: jml Owned by:
Priority: highest Milestone:
Component: trial Keywords:
Cc: Branch:
Author: Launchpad Bug:

Description

Currently, it says:

 Generate  coverage  information in the given directory (relative
 to _trial_temp). Requires Python 2.3 or higher.

At the moment, trial doesn't let you set the coverage directory. It is always _trial_temp/coverage/. The man page should also have a stab at explaining what to do with the coverage output.

Change History (7)

comment:1 Changed 8 years ago by glyph

Trial should also let you set the coverage directory, in addition to the immediate bugfix for the docs. Is there a ticket for that? It should be linked here.

comment:2 Changed 8 years ago by jml

No there isn't. Please file one.

comment:3 Changed 8 years ago by exarkun

Um. Don't file that ticket, please. Trial used to let you set the coverage directory, that's why the documentation says it does. It doesn't let you do that anymore and I can't think of any reason for it to. If you can, please write up an extensive justification so that 6 months from now someone doesn't decide it would be a good idea to delete it again.

comment:4 Changed 8 years ago by exarkun

  • Keywords review added
  • Owner jml deleted
  • Priority changed from high to highest

Doc fix is ready for review in coverage-docs-2309

comment:5 Changed 8 years ago by jerub

  • Keywords review removed

Excellent. Please merge this documentation change.

comment:6 Changed 8 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [19065]) Merge coverage-docs-2309

Author: exarkun
Reviewer: jerub
Fixes #2309

Correct docstring and man page documentation of trial's --coverage
option so that it does not incorrectly suggest that a parameter is
accepted by the option which specifies the coverage output directory.

comment:7 Changed 3 years ago by <automation>

Note: See TracTickets for help on using tickets.