Add single-backtick convention for docstring code references to agent skill#1665
Merged
nathanjmcdougall merged 3 commits intomainfrom Mar 31, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d73e16e3-0b7f-41bc-8cf7-67d8cda93221 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update agent config for code reference style in docstrings
Add single-backtick convention for docstring code references to agent skill
Mar 31, 2026
10 tasks
nathanjmcdougall
approved these changes
Mar 31, 2026
Copilot AI
added a commit
that referenced
this pull request
Mar 31, 2026
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/5fcc73f0-8882-4f34-b2a5-64541f9d5bc8 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
nathanjmcdougall
deleted the
copilot/update-docstring-code-reference-style
branch
nathanjmcdougall
added a commit
that referenced
this pull request
Mar 31, 2026
* Initial plan * Add `usethis show license` command with heuristic license detection Implements license detection using three heuristics: 1. Scan common license files at root using `identify[license]` package 2. Read `project.license` field from pyproject.toml (PEP 639/621) 3. Check `project.classifiers` for license classifiers Outputs the license in SPDX format. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/737efe22-3ae6-4f6b-9a10-74becba773ee Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Fix Ruff PLR0911, sync AGENTS.md with auto-generated docs Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/737efe22-3ae6-4f6b-9a10-74becba773ee Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Narrow exception handling per code review feedback Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/737efe22-3ae6-4f6b-9a10-74becba773ee Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Replace double backticks with single backticks in docstrings per #1665 Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/5fcc73f0-8882-4f34-b2a5-64541f9d5bc8 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> * Don't recommend license classifiers in error message Trove classifiers for licenses are deprecated. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com> Co-authored-by: Nathan McDougall <nathan.j.mcdougall@gmail.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
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.
Agents were using RST-style double backticks (
``) in docstrings instead of Markdown single backticks (`). Theexport-functions.pyhook already normalizes these, but docstrings should be written correctly from the start.usethis-python-codeskill with convention, examples, and rationale