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

Improve compliance with Sphinx syntax in documentation #1189

Merged
merged 4 commits into from
Aug 25, 2024

Conversation

jakob-keller
Copy link
Collaborator

Description of Change

Closes #1162

Assumptions

None

Checklist for All Submissions

  • I have added change info to CHANGES.rst
  • If this is resolving an issue (needed so future developers can determine if change is still necessary and under what conditions) (can be provided via link to issue with these details):
    • Detailed description of issue
    • Alternative methods considered (if any)
    • How issue is being resolved
    • How issue can be reproduced
  • If this is providing a new feature (can be provided via link to issue with these details):
    • Detailed description of new feature
    • Why needed
    • Alternatives methods considered (if any)

Checklist when updating botocore and/or aiohttp versions

  • I have read and followed CONTRIBUTING.rst
  • I have updated test_patches.py where/if appropriate (also check if no changes necessary)
  • I have ensured that the awscli/boto3 versions match the updated botocore version

@jakob-keller jakob-keller added the documentation Improvements or additions to documentation label Aug 24, 2024
@jakob-keller jakob-keller self-assigned this Aug 24, 2024
Copy link

codecov bot commented Aug 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.94%. Comparing base (881414e) to head (90ff11a).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1189      +/-   ##
==========================================
- Coverage   86.99%   86.94%   -0.06%     
==========================================
  Files          64       64              
  Lines        5983     5983              
==========================================
- Hits         5205     5202       -3     
- Misses        778      781       +3     
Flag Coverage Δ
unittests 86.94% <ø> (-0.06%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@webknjaz
Copy link
Member

I'd imagine those single backticks would just become double instead of italics. That was probably the original intent behind having the backticks in the first place..

@jakob-keller jakob-keller force-pushed the docs-fixup branch 3 times, most recently from b1f7f1d to 0c3717f Compare August 24, 2024 19:01
@jakob-keller
Copy link
Collaborator Author

I'd imagine those single backticks would just become double instead of italics. That was probably the original intent behind having the backticks in the first place..

Thanks, that makes sense. Pushed double backticks... Looks like readthedocs.orgCI is broken.

@jakob-keller
Copy link
Collaborator Author

And we're back...

@jakob-keller jakob-keller merged commit 69ceb7a into aio-libs:master Aug 25, 2024
11 checks passed
@jakob-keller jakob-keller deleted the docs-fixup branch August 25, 2024 19:03
@webknjaz
Copy link
Member

Remember to add -n -W --keep-going to the invocation in a follow-up.

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

Successfully merging this pull request may close these issues.

Improve use of Sphinx syntax
3 participants