Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a colon to enable google style docstring parsing (trivial) #884

Merged
merged 2 commits into from
Dec 16, 2023
Merged

Add a colon to enable google style docstring parsing (trivial) #884

merged 2 commits into from
Dec 16, 2023

Conversation

seyhbold
Copy link

@seyhbold seyhbold commented Dec 14, 2023

📒 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

Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4d4279b) 99.89% compared to head (852ea52) 99.89%.

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.
📢 Have feedback on the report? Share it here.

Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Owner

@tefra tefra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How could this go undetected for so long lol, Thank you very much @seyhbold,

@tefra tefra merged commit d9c6ada into tefra:main Dec 16, 2023
@seyhbold
Copy link
Author

Probably no one generate docs anymore. 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants