Skip to content

docs: document channel input errors - #1908

Open
happykawayigt wants to merge 1 commit into
vprusso:masterfrom
happykawayigt:docs/channel-errors
Open

docs: document channel input errors#1908
happykawayigt wants to merge 1 commit into
vprusso:masterfrom
happykawayigt:docs/channel-errors

Conversation

@happykawayigt

Copy link
Copy Markdown
Contributor

Description

Documents explicit input-validation exceptions in two channel APIs as part of #1888.

Changes

  • Document the invalid sys and empty Kraus-list cases in kraus_to_choi.
  • Document rectangular-space, dimension-mismatch, inconsistent Kraus-size, and invalid dim cases in channel_dim.

Checklist

  • Use ruff for errors related to code style and formatting.
  • Verify all previous and newly added unit tests pass in pytest.
  • Check the documentation build does not lead to any failures.

Validation

  • Targeted tests: 28 passed
  • ruff check
  • ruff format --check
  • git diff --check

A full local MkDocs build was not run because the documentation dependency group is not installed in this worktree.

AI assistance

Implemented and reviewed with OpenAI Codex; all listed validation commands were run locally.

@codecov

codecov Bot commented Aug 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@happykawayigt
happykawayigt marked this pull request as ready for review August 1, 2026 15:47
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