Add docstrings for release-to-pypi-uv tests and helpers

[leynos]

Summary

• document the determine_release.main entrypoint with a numpy-style docstring
• add docstrings to the release-to-pypi-uv fixtures, helpers, and tests so D1 passes
• introduce module-level docstrings for the shared test package and rust target install tests

Testing

• uvx ruff check --select D1

---

https://chatgpt.com/codex/tasks/task_e_68d00bbad2908322a2cde4ffc2153875

Summary by Sourcery

Add comprehensive numpy-style docstrings to tests, fixtures, and helper modules across the release-to-pypi-uv and rust-build-release workflows and define Protocol types for the cmd-mox fixture interface to satisfy D1 lint requirements.

Enhancements:

• Document determine_release.main entrypoint with a numpy-style docstring
• Add detailed docstrings to fixtures, helpers, and test functions in the release-to-pypi-uv action suite
• Introduce module-level docstrings for shared test packages and rust target install tests
• Define Protocol types (CommandDouble, SpyDouble, CmdMoxEnvironment, CmdMoxFixture) in conftest to type the cmd-mox fixture interface

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/run-ruff-check-and-fix-lint-violations

---

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

[sourcery-ai]

Reviewer's Guide

This PR enhances documentation across the release-to-pypi-uv and rust-build-release test suites and scripts by adding numpy-style docstrings to functions, classes, fixtures, and modules, enriching conftest with typed Protocol definitions, and updating tests to import and type-annotate cmd_mox fixtures.

Class diagram for new Protocols in conftest.py

classDiagram
    class CommandDouble {
        +with_args(*args: str) CommandDouble
        +returns(stdout: str = "", stderr: str = "", exit_code: int = 0, **_: object) CommandDouble
        +runs(handler: Callable[[object], CommandResponse]) CommandDouble
    }
    class SpyDouble {
        call_count: int
    }
    class CmdMoxEnvironment {
        shim_dir: Path
    }
    class CmdMoxFixture {
        environment: CmdMoxEnvironment
        +stub(command: str) CommandDouble
        +spy(command: str) SpyDouble
        +replay() None
        +verify() None
    }
    CommandDouble <|.. SpyDouble
    CmdMoxFixture o-- CmdMoxEnvironment
    CmdMoxFixture --> CommandDouble
    CmdMoxFixture --> SpyDouble

Loading

File-Level Changes

Change	Details	Files
Add numpy-style docstrings to release-to-pypi-uv tests and fixtures	Document DummyResponse class and its methods Annotate pytest fixtures with parameter and return descriptions Add docstrings to each test function describing behavior and parameters	.github/actions/release-to-pypi-uv/tests/test_check_github_release.py .github/actions/release-to-pypi-uv/tests/test_validate_toml_versions.py .github/actions/release-to-pypi-uv/tests/test_publish_release.py .github/actions/release-to-pypi-uv/tests/test_write_summary.py .github/actions/release-to-pypi-uv/tests/test_confirm_release.py
Introduce module-level docstring for shared test package	Add top-level docstring describing the purpose of the test helpers package	.github/actions/release-to-pypi-uv/tests/__init__.py
Document determine_release.main entrypoint	Add numpy-style docstring describing parameters and raised errors	.github/actions/release-to-pypi-uv/scripts/determine_release.py
Enrich conftest.py with typed Protocols and docstrings	Define CommandDouble, SpyDouble, CmdMoxEnvironment, CmdMoxFixture protocols with docstrings Type-annotate and document helper functions and fixtures	conftest.py
Update rust-build-release tests to import and type-annotate cmd_mox	Import CmdMoxFixture from shared_actions_conftest Type annotate cmd_mox parameter in test functions	.github/actions/rust-build-release/tests/test_cross_install.py .github/actions/rust-build-release/tests/test_target_install.py .github/actions/rust-build-release/tests/test_utils.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Many of the newly added docstrings in test and fixture functions restate what is already clear from the function name and signature—consider trimming or omitting redundant entries to keep the code concise.
• When writing numpy-style docstrings, ensure consistent section ordering, indentation, and blank lines across all modules and functions to improve readability and maintainability.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Many of the newly added docstrings in test and fixture functions restate what is already clear from the function name and signature—consider trimming or omitting redundant entries to keep the code concise.
- When writing numpy-style docstrings, ensure consistent section ordering, indentation, and blank lines across all modules and functions to improve readability and maintainability.

## Individual Comments

### Comment 1
<location> `conftest.py:27` </location>
<code_context>
+type CommandResponse = tuple[str, str, int]
+
+
+class CommandDouble(Protocol):
+    """Contract for command doubles returned by cmd-mox helpers."""
+
</code_context>

<issue_to_address>
**issue (complexity):** Consider merging the four Protocols into two and removing unnecessary type aliases to reduce boilerplate.

```markdown
You can collapse those four Protocols into just two, removing the `CommandResponse` alias and inlining `shim_dir` on the fixture Protocol. For example:

```python
from pathlib import Path
from typing import Protocol, Callable, Any

class CmdDouble(Protocol):
    call_count: int

    def with_args(self, *args: str) -> CmdDouble: ...
    def returns(self, *, stdout: str = "", stderr: str = "", exit_code: int = 0, **_: Any) -> CmdDouble: ...
    def runs(self, handler: Callable[[Any], tuple[str, str, int]]) -> CmdDouble: ...
```

```python
class CmdMox(Protocol):
    shim_dir: Path

    def stub(self, command: str) -> CmdDouble: ...
    def spy(self, command: str) -> CmdDouble: ...
    def replay(self) -> None: ...
    def verify(self) -> None: ...
```

Then drop `SpyDouble`, `CmdMoxEnvironment`, `CmdMoxFixture` and `CommandResponse`, and simply annotate your helpers:

```python
def _register_cross_version_stub(
    cmd_mox: CmdMox,
    stdout: str | Iterable[str] = "cross 0.2.5\n",
) -> str:
    if isinstance(stdout, str):
        cmd_mox.stub("cross").with_args("--version").returns(stdout=stdout)
    else:
        # ...
    return str(cmd_mox.shim_dir / "cross")
```

This preserves all typing and functionality but halves the amount of Protocol boilerplate.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}