Skip to content

Correct decoder documentation - #42945

Merged
vbraun merged 3 commits into
sagemath:developfrom
EliNaig:fix-decoder-docs-28340
Oct 11, 2026
Merged

vbraun merged 3 commits into
sagemath:developfrom
EliNaig:fix-decoder-docs-28340

Conversation

@EliNaig

@EliNaig EliNaig commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Several decoders described their input r as "a codeword of self". Since r may contain errors, the documentation now describes it as "a vector of the ambient space of self.code()", consistent with other decoders.

Also corrects the output descriptions: decode_to_code returns a codeword, while the Berlekamp-Welch and Gao decode_to_message methods return polynomials, not vectors. Minor wording errors are also fixed.

Files: linear_code.py, linear_rank_metric.py, grs_code.py.

Fixes #28340.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

None.

@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown

Documentation preview for this PR (built with commit 8733e60; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@vbraun
vbraun merged commit fab8689 into sagemath:develop Oct 11, 2026
13 of 22 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.

wrong wording

2 participants