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

Fix docstring formatting in create_file and update_file #2940

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

xmo-odoo
Copy link
Contributor

@xmo-odoo xmo-odoo commented Apr 5, 2024

Formatting is currently broken as can be seen on the published documentation: line-breaking to the first column makes rST thing the info list has ended and go back to regular content, making a hash of the rest of the commit until reaching the next indented section which is interpreted as a quote, following which the new info fields are seen again.

Formatting is currently broken as can be seen on [the published
documentation](https://pygithub.readthedocs.io/en/v2.3.0/github_objects/Repository.html#github.Repository.Repository.create_file):
line-breaking to the first column makes rST thing the info list has ended and
go back to regular content, making a hash of the rest of the commit until
reaching the next indented section which is interpreted as a quote, following
which the new info fields are seen again.
@xmo-odoo
Copy link
Contributor Author

xmo-odoo commented Apr 5, 2024

  • looks like the docformatter pass from precommit is completely broken for info fields as it asks me to revert specifically what I'm fixing (create_file with fix)
  • the documentation build is full of warnings, I assume from exactly the issue I'm fixing here
  • I tried building the documentation locally, but it doesn't look like whatever magic the conf.py does works, the documentation builds with no error then all the github object pages are empty

@codecov-commenter
Copy link

codecov-commenter commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.74%. Comparing base (7266e81) to head (353faeb).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2940   +/-   ##
=======================================
  Coverage   96.74%   96.74%           
=======================================
  Files         147      147           
  Lines       14978    14978           
=======================================
  Hits        14491    14491           
  Misses        487      487           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

None yet

2 participants