Repository navigation
docs: Configure Google docstrings with Ruff and MkDocs - #4798
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
go2 replay realtime (arm64)
Details
| Benchmark suite | Current: dcc482f | Previous: 5daef81 | Ratio |
|---|---|---|---|
peak memory |
1711.172 MB |
1686.902 MB |
1.01 |
peak threads |
376 threads |
361 threads |
1.04 |
network (transport) |
2733.777 MB |
2732.025 MB |
1.00 |
disk write |
1.508 MB |
1.723 MB |
0.88 |
instructions |
135.984 G |
136.239 G |
1.00 |
This comment was automatically generated by workflow using github-action-benchmark.
❌ 1 Tests Failed:
View the top 1 failed test(s) by shortest run time
To view more test analytics, go to the Test Analytics Dashboard |
TomCC7
commented
Oct 23, 2026
TomCC7
commented
Oct 23, 2026
TomCC7
marked this pull request as ready for review
October 23, 2026 21:39
TomCC7
requested review from
Dreamsorcerer,
aclauer,
bogwi,
jeff-hykin,
leshy,
mustafab0,
paul-nechifor and
spomichter
as code owners
October 23, 2026 21:39
Contributor
[Medium impact] No outstanding findings block merging these changes. SummaryConfigures Google docstrings with Ruff and the standard MkDocs Python handler.
Reviews (2) · Last reviewed commit: "refactor: remove custom docs helpers and..." · Reviewed by Greptile |
TomCC7
marked this pull request as draft
October 23, 2026 23:36
TomCC7
marked this pull request as ready for review
October 23, 2026 23:52
Dreamsorcerer
approved these changes
Oct 24, 2026
paul-nechifor
approved these changes
Oct 24, 2026
TomCC7
enabled auto-merge (squash)
October 24, 2026 05:42
This branch was successfully deployed
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.
Configure Google docstrings using Ruff's existing D405/D416 rules and the standard MkDocs Python handler. Ruff checks recognized section headings; it does not reject every NumPy, reST, or Epydoc format. No docstring-presence, parameter-completeness, ANN, or DOC rules are enabled, and existing mypy settings are unchanged.
Convert only the 14 SceneClient method docstrings needed for these rules. SceneClient's executable AST and annotations are unchanged.
MkDocs uses mkdocstrings[python], Google parsing, existing annotation display, and disabled missing-type warnings. This PR adds no automatic API reference pages or embedded API examples. There are no new Python tooling scripts, custom Griffe extensions, HTML fixtures, or runtime package-structure changes. CI uses the standard
mkdocs build --strictcommand.Docs tooling requires Python 3.11 or newer; runtime Python support is unchanged. Available annotations will be rendered when API references are added later; the current site does not gain generated API coverage from this configuration alone.
Validation: whole-repository Ruff, changed Python formatting, lockfile consistency, and full
mkdocs build --strict. Confirmed zero added Python files, removed helper references, unchanged mypy configuration, and unchanged existing configuration guide/navigation. Full mypy and the complete pre-commit suite were not run.