Main - #10
Closed
sztal wants to merge 3 commits into
Closed
Conversation
Add agent documentation and devnotes template support
There was a problem hiding this comment.
🟡 Changes recommended
Docstring convention was changed to NumPy in Ruff, but the docs templates’ mkdocstrings configuration still parses Google-style docstrings, creating a functional mismatch for generated documentation.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the project template’s contributor guidance and linting defaults by adding a Python style guide and agent/devnote templates, and aligning Ruff’s docstring convention toward NumPy-style docstrings.
Changes:
- Add
STYLE.mdto document Python coding, documentation, design, and testing conventions. - Switch Ruff
pydocstyleconvention in the templatepyproject.tomlfrom Google to NumPy. - Add
AGENTS.mdand adevnotes/example to guide agent workflows and development note-taking.
File summaries
| File | Description |
|---|---|
| template/STYLE.md | Introduces a Python style guide to complement Ruff/mypy/pytest configuration. |
| template/pyproject.toml.jinja | Updates Ruff pydocstyle convention to numpy for generated projects. |
| template/devnotes/example.md | Adds a template for structured development notes. |
| template/AGENTS.md.jinja | Adds an agent guide describing project conventions and validation commands. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+143
to
144
| lint.pydocstyle.convention = "numpy" | ||
| lint.future-annotations = true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.