fix (docs): reverse documentation for callVariant#946
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the module-level docstring for callVariant CLI to provide comprehensive documentation about its functionality. The brief one-line description has been replaced with a detailed multi-paragraph explanation of how callVariant processes GVF files and generates variant peptides.
Key Changes
- Expanded the module docstring from a single line to a detailed 10-line description explaining the core algorithm and workflow
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| INDEL, fusion, alternative splicing, RNA editing, and circRNA). The transcript | ||
| variant graph is then translated into a peptide variant graph, followed by | ||
| converting to a cleavage graph based on the enzymatic cleavage rule. The | ||
| variant peptide graph is than used to call for variant peptides that contains |
There was a problem hiding this comment.
Corrected spelling of 'than' to 'then' - should be 'then' when referring to sequence of events.
| variant peptide graph is than used to call for variant peptides that contains | |
| variant peptide graph is then used to call for variant peptides that contains |
| INDEL, fusion, alternative splicing, RNA editing, and circRNA). The transcript | ||
| variant graph is then translated into a peptide variant graph, followed by | ||
| converting to a cleavage graph based on the enzymatic cleavage rule. The | ||
| variant peptide graph is than used to call for variant peptides that contains |
There was a problem hiding this comment.
Grammar error: 'contains' should be 'contain' to agree with the plural subject 'peptides'.
| variant peptide graph is than used to call for variant peptides that contains | |
| variant peptide graph is than used to call for variant peptides that contain |
| variant graph is then translated into a peptide variant graph, followed by | ||
| converting to a cleavage graph based on the enzymatic cleavage rule. The | ||
| variant peptide graph is than used to call for variant peptides that contains | ||
| at least one variant, and do not present in the canonical peptide pool. |
There was a problem hiding this comment.
Grammar error: 'present' should be 'are present' or change to 'and are not present' for correct verb form.
| at least one variant, and do not present in the canonical peptide pool. | |
| at least one variant, and are not present in the canonical peptide pool. |
Description
Closes #...
Checklist
.png, .jpeg),.pdf,.RData,.xlsx,.doc,.ppt, or other non-plain-text files. To automatically exclude such files using a .gitignore file, see here for example.CHANGELOG.mdunder the next release version or unreleased, and updated the date.