Add a colon to enable google style docstring parsing (trivial)#884
Merged
tefra merged 2 commits intotefra:mainfrom Dec 16, 2023
seyhbold:main
Merged
Add a colon to enable google style docstring parsing (trivial)#884tefra merged 2 commits intotefra:mainfrom seyhbold:main
tefra merged 2 commits intotefra:mainfrom
seyhbold:main
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #884 +/- ##
=======================================
Coverage 99.89% 99.89%
=======================================
Files 105 105
Lines 9311 9311
Branches 2080 2080
=======================================
Hits 9301 9301
Misses 3 3
Partials 7 7 ☔ View full report in Codecov by Sentry. |
|
Author
|
Probably no one generate docs anymore. 🤔 |
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.

📒 Description
I tried to generate mkdocs of the generated classes with
https://mkdocstrings.github.io/python/
It fails because a colon is missing:
https://google.github.io/styleguide/pyguide.html#384-classes
🔗 What I've Done
I added a colon to the doctring Jinja Template
💬 Comments
🛫 Checklist
Updated docsAdded unit-tests