Update CrosscheckFingerprints summary #1721
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
I've revised the introduction to the CrosscheckFingerprints doc for improved readability. The previous reference to "moltenized" output has been changed to "molten" for the sake of standardization.
5 tasks
samuelklee
force-pushed
the
sl_crosscheckfingerprints_docs
branch
from
23d9d66 to
68f779a
Compare
yfarjoun
reviewed
Sep 18, 2021
| "logged. As long as there is at least one comparison where both sides have observations at fingerprinting sites, the tool will " + | ||
| "return zero. However, if all comparisons have at least one side with no observations at fingerprinting sites, an error will be " + | ||
| "logged and the tool will return EXIT_CODE_WHEN_NO_VALID_CHECKS." + | ||
| "Note that, as long as there is at least one comparison in which both files have observations at fingerprinting sites, the tool will return a ‘zero’. However, an error will be logged and the tool will return EXIT_CODE_WHEN_NO_VALID_CHECKS if all comparisons have at least one side without observations at a fingerprinting site (ie. all LOD scores are zero). \n" + |
There was a problem hiding this comment.
here too, as in other places, I think that a long line of text is harder to read in code...please revert this back to multiple lines....
|
@derekca can you update this with Yossi's comments? |
Apologies for removing the line breaks, I wasn't aware I was affecting the readability. My focus was on the content. Hopefully I've addressed everything.
…ckFingerprints_summary_200915
droazen
changed the base branch from
sl_crosscheckfingerprints_docs
to
master
kachulis
approved these changes
Feb 14, 2023
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.
Description
I've revised the introduction to the CrosscheckFingerprints doc for improved readability, which was a common criticism of this particular doc at the time of the original drafting of this revision.
The reference to "moltenized" output has been changed to "molten" for the sake of standardization, as per samuelklee's suggestion on the previous draft.
Checklist (never delete this)
Never delete this, it is our record that procedure was followed. If you find that for whatever reason one of the checklist points doesn't apply to your PR, you can leave it unchecked but please add an explanation below.
Content
Review
For more detailed guidelines, see https://github.com/broadinstitute/picard/wiki/Guidelines-for-pull-requests