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 broken urls in docstrings #2393

Merged
merged 2 commits into from Jun 1, 2023

Conversation

Muscaw
Copy link
Contributor

@Muscaw Muscaw commented Dec 30, 2022

I noticed that the URLs for accept_invitation and get_repos are broken on ReadTheDocs.

By adding the underscore at the end, it fixes the link when rendered with Sphinx

@codecov-commenter
Copy link

codecov-commenter commented Dec 30, 2022

Codecov Report

Patch coverage has no change and project coverage change: -0.02 ⚠️

Comparison is base (300c501) 98.77% compared to head (96de0d1) 98.75%.

❗ Current head 96de0d1 differs from pull request most recent head 26c8dbf. Consider uploading reports for the commit 26c8dbf to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2393      +/-   ##
==========================================
- Coverage   98.77%   98.75%   -0.02%     
==========================================
  Files         117      115       -2     
  Lines       11674    11595      -79     
==========================================
- Hits        11531    11451      -80     
- Misses        143      144       +1     
Impacted Files Coverage Δ
github/AuthenticatedUser.py 99.04% <ø> (ø)
github/Branch.py 92.50% <ø> (ø)
github/Repository.py 97.20% <ø> (ø)
github/Team.py 98.54% <ø> (ø)

... and 7 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@EnricoMi
Copy link
Collaborator

EnricoMi commented Feb 1, 2023

While we are there, can you also fix the missing _ in

  • Branch.py
  • Repository.py
  • Team.py

I found those occurrences by searching for regexp ">`$":

grep -E -e ">\`$" -R github

@Muscaw
Copy link
Contributor Author

Muscaw commented Feb 1, 2023

@EnricoMi Good catch. Thanks for the command.

Copy link
Collaborator

@EnricoMi EnricoMi left a comment

Choose a reason for hiding this comment

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

@EnricoMi EnricoMi force-pushed the fix-urls-in-authenticated-user branch from 96de0d1 to 26c8dbf Compare April 24, 2023 08:13
@EnricoMi EnricoMi force-pushed the fix-urls-in-authenticated-user branch from 26c8dbf to d944879 Compare June 1, 2023 08:10
@EnricoMi EnricoMi changed the title Fix broken urls in AuthenticatedUser docstrings Fix broken urls in docstrings Jun 1, 2023
@EnricoMi EnricoMi merged commit f82ad61 into PyGithub:master Jun 1, 2023
7 checks passed
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

3 participants