Skip to content

DOC: clarify n_reads_learn help text#191

Merged
gregcaporaso merged 2 commits into
qiime2:devfrom
Abdeltoto:docs/clarify-n-reads-learn
Jun 4, 2026
Merged

DOC: clarify n_reads_learn help text#191
gregcaporaso merged 2 commits into
qiime2:devfrom
Abdeltoto:docs/clarify-n-reads-learn

Conversation

@Abdeltoto

@Abdeltoto Abdeltoto commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Clarify that n_reads_learn is passed through as --learn_min_reads.
  • Apply the same help text clarification across the denoise actions that expose n_reads_learn.

Test plan

  • python -m py_compile q2_dada2/plugin_setup.py

AI disclosure

AI assistance was used for codebase navigation and wording suggestions. I reviewed the relevant q2-dada2 code paths and edited the final change before submitting.

Refs #186.

@gregcaporaso

Copy link
Copy Markdown
Member

@Abdeltoto, this help text isn't correct - the value gets passed as --learn_min_reads to DADA2. If you'd like to update that, we'll accept this PR (though note that we are planning to replace this parameter so this will be a short-lived addition).

Please also review our AI Code Policy and ensure that your disclosures are in place as needed.

@github-project-automation github-project-automation Bot moved this to Backlog in 2026.7 🐐 May 7, 2026
@gregcaporaso gregcaporaso moved this from Backlog to In Development in 2026.7 🐐 May 7, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in QIIME 2 - Triage 🚑 May 7, 2026
@gregcaporaso gregcaporaso moved this from Needs Triage to Awaiting Info in QIIME 2 - Triage 🚑 May 7, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
@Abdeltoto

Copy link
Copy Markdown
Contributor Author

Thanks for the correction. I updated the help text to describe the value as being passed through as --learn_min_reads\ instead of
reads, and added an AI disclosure to the PR description after reviewing the linked policy.

Local check: \python -m py_compile q2_dada2/plugin_setup.py.

@gregcaporaso gregcaporaso self-requested a review June 4, 2026 12:54

@gregcaporaso gregcaporaso left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now, thanks for the addition @Abdeltoto.

@gregcaporaso gregcaporaso merged commit 541a364 into qiime2:dev Jun 4, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants