DM-15138: Incorrect instructions in ap_verify readme #43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ebellm
reviewed
Aug 8, 2018
README.md
Outdated
|
|
||
| `-h, --help, --version`: These arguments print a brief usage guide and the program version, respectively. | ||
| For more details, including user instructions and information about supported datasets, consult the [package documentation](https://github.com/lsst-dm/ap_verify/tree/master/doc/lsst.ap.verify). | ||
| When `ap_verify` is formally added to the LSST Stack this documentation will be available through the Science Pipelines site. |
There was a problem hiding this comment.
I'd add a link to https://pipelines.lsst.io/ just for future-proofing.
There was a problem hiding this comment.
Done. Can you take another look?
ebellm
previously approved these changes
Aug 8, 2018
With the introduction of Sphinx package documentation, all the readme really needs is a brief overview of what ap_verify is and what is needed to get it to work.
kfindeisen
force-pushed
the
tickets/DM-15138
branch
from
4fc4f2e
to
d04ed42
Compare
ebellm
approved these changes
Aug 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the readme to use the modern boilerplate (from templates) and one-sentence-per-line formatting style, plus a brief explanation that
ap_verifycannot be used by itself (since the dataset system is a significant deviation from normal Stack idioms). The old usage information is deferred to the documentation.This PR also fixes some misleading text in the command-line examples.