Skip to content

Document and validate that CreateGermlines only supports nucleotide sequences#229

Merged
ssnn-airr merged 4 commits into
masterfrom
copilot/improve-error-message-documentation
Feb 13, 2026
Merged

Document and validate that CreateGermlines only supports nucleotide sequences#229
ssnn-airr merged 4 commits into
masterfrom
copilot/improve-error-message-documentation

Conversation

Copilot AI commented Feb 13, 2026

Copy link
Copy Markdown
Contributor

CreateGermlines does not support amino acid sequences but fails with cryptic errors when users attempt to use amino acid fields like sequence_alignment_aa.

Changes

  • Added field validation - Detects common amino acid field names (sequence_aa, sequence_alignment_aa, SEQUENCE_AA, SEQUENCE_ALIGNMENT_AA) and displays actionable error message before processing begins
  • Updated command-line help - --sf argument now explicitly states nucleotide-only requirement
  • Added documentation warnings - Both example and method docs now document this limitation in dedicated sections

Example

Running with amino acid field now shows:

ERROR> Reconstruction of germlines from amino acid sequences is not currently supported. 
       Please use a nucleotide sequence field (e.g., sequence_alignment or SEQUENCE_IMGT).

Instead of failing later with positional field errors.

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve error message and documentation of CreateGermlines</issue_title>
<issue_description>Reconstruction of germlines from amino acid sequences is currently not supported. Update documentation and error messages to better reflect this limitation.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…Germlines

Co-authored-by: ssnn-airr <20683719+ssnn-airr@users.noreply.github.com>
Copilot AI changed the title [WIP] Update error message and documentation for CreateGermlines Document and validate that CreateGermlines only supports nucleotide sequences Feb 13, 2026
Copilot AI requested a review from ssnn-airr February 13, 2026 11:36
@ssnn-airr ssnn-airr marked this pull request as ready for review February 13, 2026 12:36
@ssnn-airr ssnn-airr merged commit 78a2100 into master Feb 13, 2026
6 checks passed
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.

Improve error message and documentation of CreateGermlines

2 participants