Mirror the multi-line docstring rule in wb-dev codestyle summary#36
Open
ilyatikhonyuk wants to merge 3 commits into
Open
Mirror the multi-line docstring rule in wb-dev codestyle summary#36ilyatikhonyuk wants to merge 3 commits into
ilyatikhonyuk wants to merge 3 commits into
Conversation
The wb-dev codestyle reference summarizes the key Python deviations from PEP8; add the team docstring convention (always multi-line, nothing after the opening triple quotes) so the summary stays in sync with wirenboard/codestyle python.ru.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…yle-docstrings # Conflicts: # .claude-plugin/plugin.json # debian/changelog # pyproject.toml # wb_cli/__init__.py
…yle-docstrings # Conflicts: # .claude-plugin/plugin.json # debian/changelog # pyproject.toml # wb_cli/__init__.py
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.
What changed
wb-dev→references/codestyle.md, Python "Key differences" list: new bullet — docstrings are always multi-line (nothing on the line after the opening""", text starts on the next line, closing"""on its own line); not enforced by black/isort/pylint, checked in review.__init__.pyin lockstep).Why
The canonical rule lands in
wirenboard/codestylepython.ru.md(wirenboard/codestyle#123); thewb-development:codestyleskill reads that file on every run and needs no change. But thewb-devskill carries its own short summary of the Python deviations — without this bullet the summary contradicts the updated canon and an agent that reads only the summary keeps producing one-line docstrings.Test plan
Doc-only change; wording matches the codestyle PR verbatim.
Risks
🤖 Generated with Claude Code