Add documentation for the --rerun option #17
Merged
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
| start a coadd. | ||
|
|
||
| The `--rerun` can also specify a path, e.g. `--rerun rhl/tmp/foo` creates "$root/hsc/rerun/rhl/tmp/foo". A | ||
| part of this path can be a symbolic link (e.g. "$root/hsc/rerun/rhl" -> "/other/disk/rhl/rerun"). |
There was a problem hiding this comment.
This is unclear. I assume you mean that if part of the specified path exists as a symlink then all will work as expected. The text is probably fine as is, but I suggest you make the example more explicit. e.g. with the symlink you gave --rerun rhl/tmp/foo creates /other/disk/rhl/tmp/foo (if I got that right).
The --rerun option brought over from HSC was lacking good documentation. This ticket provides said documentation by sumamrizing the relevent contents of RFC-95: Filesystem Organization & Argument Parser Features.
AstroVPK
force-pushed
the
tickets/DM-4443
branch
from
f1f7ce2
to
935bf7c
Compare
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.
The --rerun option brought over from HSC was lacking good
documentation. This ticket provides said documentation by sumamrizing
the relevent contents of RFC-95: Filesystem Organization & Argument
Parser Features.