Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds build-docs.sh to the .gitignore and simplifies the A3ParseError docstring. Feedback indicates that the build script should be tracked if used in CI/CD or by others, and suggests restoring the detailed docstring for better API documentation.
| # custom docs building | ||
| build-docs.sh |
There was a problem hiding this comment.
Ignoring build-docs.sh prevents the script from being committed to the repository. If this script is intended for use by other contributors or in CI/CD pipelines to build documentation, it should be tracked. If it is a local-only script, it is better to keep it out of the repository's .gitignore and use a local exclude file instead.
| message : str | ||
| Human-readable description of the failure. | ||
| """ | ||
| """Raised when JSON parsing or file I/O fails.""" |
There was a problem hiding this comment.
The removal of the Parameters section from the docstring reduces the clarity of the exception's API. While A3ParseError is a simple exception, explicitly documenting the expected message parameter is helpful for users of the library, especially since it is used with a message throughout the codebase.
| """Raised when JSON parsing or file I/O fails.""" | |
| """Raised when JSON parsing or file I/O fails. | |
| Parameters | |
| ---------- | |
| message : str | |
| Human-readable description of the failure. | |
| """ |
There was a problem hiding this comment.
Pull request overview
This PR makes small maintenance-oriented tweaks in the Python portion of the repo: it simplifies an exception docstring and updates the Python .gitignore for a local docs build script.
Changes:
- Shorten
A3ParseError’s docstring inerrors.py. - Ignore
build-docs.shinpython/.gitignore.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
python/rtemis_a3/src/rtemis/a3/errors.py |
Simplifies the A3ParseError class docstring. |
python/.gitignore |
Adds an ignore entry for a local docs build script. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| message : str | ||
| Human-readable description of the failure. | ||
| """ | ||
| """Raised when JSON parsing or file I/O fails.""" |
There was a problem hiding this comment.
The A3ParseError docstring was shortened to a one-liner, but the rest of this package (e.g., A3ValidationError in this file and public functions in api.py/io.py) uses NumPy-style docstrings with Parameters/Raises sections. Consider restoring the structured docstring (or documenting message via an __init__) to keep generated API docs consistent.
| """Raised when JSON parsing or file I/O fails.""" | |
| """Raised when JSON parsing or file I/O fails. | |
| Parameters | |
| ---------- | |
| message : str | |
| Human-readable description of the parsing or I/O failure. | |
| """ |
No description provided.