Skip to content

docs: improve cell barcode documentation - #177

Merged
nh13 merged 1 commit into
mainfrom
nh/cell-tag-docs
Mar 20, 2026
Merged

nh13 merged 1 commit into
mainfrom
nh/cell-tag-docs

Conversation

@nh13

@nh13 nh13 commented Mar 20, 2026

Copy link
Copy Markdown
Member

Summary

  • Expanded the --cell-tag option description for both group and dedup commands to explain that reads at the same genomic coordinates are partitioned by cell barcode before UMI assignment/deduplication, preventing reads from different cells from being grouped together
  • Added a "Cell Barcodes" section to the command-level documentation for both group and dedup explaining the partitioning behavior and noting that no correction is performed on cell barcodes

Test plan

  • cargo check passes
  • Verify fgumi group --help and fgumi dedup --help display the updated documentation

@nh13
nh13 temporarily deployed to github-actions March 20, 2026 18:09 — with GitHub Actions Inactive
@coderabbitai

coderabbitai Bot commented Mar 20, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 062a0356-d345-4deb-a557-d84730cafbee

📥 Commits

Reviewing files that changed from the base of the PR and between ec8c1ab and a7bb957.

📒 Files selected for processing (2)
  • src/commands/dedup.rs
  • src/commands/group.rs

📝 Walkthrough

Walkthrough

Documentation-only updates to two CLI commands: MarkDuplicates and GroupReadsByUmi. Both expanded the --cell-tag help text to clarify that reads are partitioned by cell barcode before deduplication and grouping, preventing reads from different cells from being grouped together. New "Cell Barcodes" sections were added to both commands explaining this behavior and noting that no barcode correction or error-handling is performed. No functional code changes occurred.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: improve cell barcode documentation' clearly and concisely describes the main change—expanding documentation for cell barcode handling across multiple commands.
Description check ✅ Passed The description directly explains the changes made: expanded --cell-tag documentation and added Cell Barcodes sections to both group and dedup commands, matching the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nh/cell-tag-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented Mar 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.29%. Comparing base (ec8c1ab) to head (a7bb957).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #177   +/-   ##
=======================================
  Coverage   84.29%   84.29%           
=======================================
  Files         128      128           
  Lines       51978    51978           
=======================================
+ Hits        43814    43815    +1     
+ Misses       8164     8163    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@nh13

nh13 commented Mar 20, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Mar 20, 2026

Copy link
Copy Markdown
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@nh13
nh13 merged commit 7bccd98 into main Mar 20, 2026
7 checks passed
@nh13
nh13 deleted the nh/cell-tag-docs branch March 20, 2026 21:11
@nh13 nh13 mentioned this pull request Mar 20, 2026

This branch was previously deployed

1 inactive deployment
github-actions — a7bb9576 Deployed Mar 20, 2026 by nh13 via coverage #654
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant