Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Validation
-
Labels:None
-
Story Points:0
-
Team:SQuaRE
Description
Fix formatting in validateDrp.py --help message
The "description" currently reads as
Calculate and plot validation Key Project Metrics from the LSST SRD.
|
http://ls.st/LPM-17\n Produces results to: STDOUT Summary of key metrics
|
REPONAME*.png Plots of key metrics. Generated in current working directory.
|
REPONAME*.json JSON serialization of each KPM. where REPONAME is based on the
|
repository name but with path separators replaced with underscores. E.g.,
|
"Cfht/output" -> "Cfht_output_"
|
But it should read (as written in the string):
description = """
|
Calculate and plot validation Key Project Metrics from the LSST SRD.
|
http://ls.st/LPM-17
|
|
|
Produces results to:
|
STDOUT
|
Summary of key metrics
|
REPONAME*.png
|
Plots of key metrics. Generated in current working directory.
|
REPONAME*.json
|
JSON serialization of each KPM.
|
|
|
where REPONAME is based on the repository name but with path separators
|
replaced with underscores. E.g., "Cfht/output" -> "Cfht_output_"
|
"""
|
- I think this is just a matter of passing formatter_class=argparse.RawDescriptionHelpFormatter to argparse.ArgumentParser
Attachments
Issue Links
- relates to
-
DM-5510 QA Tasks & Supertasks II
- Done
Activity
Looks very useful. The PR has a minor recommendation for improvement (I'd opt for the module-level description approach).
Merged to master.
Minor suggestion adopted.
Michael Wood-Vasey
added a comment - Merged to master.
Minor suggestion adopted. 
This is a trivial one-line addition to fix up the formatting in the help message.