docs: Add AGENTS.md and improve Scatter docstring#6778
Open
MarcSkovMadsen wants to merge 4 commits intomainfrom
Open
docs: Add AGENTS.md and improve Scatter docstring#6778MarcSkovMadsen wants to merge 4 commits intomainfrom
MarcSkovMadsen wants to merge 4 commits intomainfrom
Conversation
- Add comprehensive AGENTS.md file with project setup, testing, and style guidelines - Update Scatter class docstring with clear examples using code blocks (::) format - Include examples for basic scatter, styled scatter, and multi-dimensional data - Follow NumPy docstring conventions for better documentation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive AI agent guidance documentation and improves the Scatter class docstring to make HoloViews more accessible for development with AI assistance and provide better documentation for users.
- Added AGENTS.md file with detailed instructions for AI coding agents covering setup, testing, code style, and docstring conventions
- Enhanced Scatter docstring with practical examples using the preferred
::code block format and clearer explanations of dimensions - Established NumPy docstring conventions as the standard with specific formatting preferences
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| AGENTS.md | New file providing comprehensive guidance for AI coding agents, including project setup, testing procedures, code style guidelines, and docstring formatting conventions |
| holoviews/element/chart.py | Enhanced Scatter class docstring with improved description, three practical examples, "See Also" references, and a reference link to the documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
1 participant
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.
Context
Working with HoloViews, I saw that it would be a quick win to update the Element/ Chart docstrings to make them more useful across development environments.
This is a minimal PR testing out if improved docstring PRs could be accepted. And to focus on the principles for docstring updates.
If approved and merged I would be interested in updating the docstrings more systematically.
Since I want to work efficiently with AI assistance I also added an AGENTS.md file. The purpose was to guide docstring development. But since there was no existing AGENTS.md I tried to add the most basic instructions too.
Changes
Before
After
holoviews-scatter-docstring.mp4