Add prek hook to forbid double backticks in docstrings#1826
Closed
Add prek hook to forbid double backticks in docstrings#1826
Conversation
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/227bc20a-2bb1-4c15-8485-8e6694a90951 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/227bc20a-2bb1-4c15-8485-8e6694a90951 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add prek hook to forbid double backticks in docstrings
Add prek hook to forbid double backticks in docstrings
Apr 6, 2026
| @@ -119,13 +119,11 @@ def _get_child_dependencies( | |||
| `a` does not depend on anything, and `c` depends on `a` through `b`. Then the | |||
| function will return: | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
This isn't good, I'll need to try a different design.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 and developers sometimes write RST-style double backtick markup (
foo) in docstrings when single backticks should be used. This project uses Markdown-compatible docstrings, not RST.New hook:
hooks/check-docstring-substrings.pyGeneral-purpose prek hook that parses Python files with
ast, extracts only docstring nodes, and checks them for forbidden substrings. Accepts--forbiddenargs and file paths:Multiple forbidden substrings supported via repeated
--forbiddenflags.Existing violations fixed
Converted all
...→`...`in docstrings across 12 files insrc/andhooks/. One triple-backtick code fence inimports.pyconverted to an indented code block to avoid false positives.