Skip to content

Zensical #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
egenn merged 2 commits into from
Mar 31, 2026
Merged

Zensical #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
863c13d
docs
egenn Mar 31, 2026
694df94
add build-docs.sh
egenn Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions python/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,5 @@ htmlcov/
# Docs output
site/

# custom docs building
build-docs.sh
Comment on lines +41 to +42
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

8 changes: 1 addition & 7 deletions python/rtemis_a3/src/rtemis/a3/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,4 @@ def __init__(self, message: str, errors: list[dict[str, Any]] | None = None):


class A3ParseError(Exception):
"""Raised when JSON parsing or file I/O fails.

Parameters
----------
message : str
Human-readable description of the failure.
"""
"""Raised when JSON parsing or file I/O fails."""
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
"""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.
"""

Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
"""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.
"""

Copilot uses AI. Check for mistakes.
Loading