Use @inheritParams for multiomics parameter documentation#19
Open
Copilot wants to merge 5 commits intoupdate_multiomics_docsfrom
Open
Use @inheritParams for multiomics parameter documentation#19Copilot wants to merge 5 commits intoupdate_multiomics_docsfrom
Copilot wants to merge 5 commits intoupdate_multiomics_docsfrom
Conversation
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for multiomics functions
Complete roxygen2 documentation for multiomics functions
Feb 13, 2026
Collaborator
|
Where possible, you should use @inheritParams to avoid repetition of argument description text |
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Co-authored-by: MVesuviusC <5831817+MVesuviusC@users.noreply.github.com>
Copilot
AI
changed the title
Complete roxygen2 documentation for multiomics functions
Use @inheritParams for multiomics parameter documentation
Feb 13, 2026
This file contains hidden or 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
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.
Parameter descriptions for
sobject,gtf,frag_files, andverbosewere duplicated across multiomics functions.Changes
add_nucleosome_signaldefinessobject(ATAC processing context); inherited bytss_enrichment,calc_frip,process_seurat_atacmerge_gex_atacinheritsverbosefromprocess_seurat_atacadd_atac_metadatainherits from multiple sources (annotate_atacforsobject/gtf,calc_fripforfrag_files/verbose)Example
Before:
After:
Reduces ~15 lines of duplicated documentation while maintaining identical generated .Rd files.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.