Skip to content

Conversation

@shuuji3
Copy link
Contributor

@shuuji3shuuji3 commented Feb 24, 2024

Description of the Change

Hello, I've read through all the documentation pages and refactored them to have consistent markups. Also, fixed several errors during the proofreading.

All changes are documentation clean up so I combined the same kind of changes into each commit, but if you feel this PR contains too many changes, I can split this PR into small chunks. 🙂

Checklist

  • PR only contains one change (considered splitting up PR)
  • [N/A] unit-test added
  • [x documentation updated
  • [N/A] CHANGELOG.md updated (only for user relevant changes)
  • author name in AUTHORS

@codecov
Copy link

codecovbot commented Feb 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.56%. Comparing base (817eb40) to head (90bddf9).

Additional details and impacted files
@@ Coverage Diff @@## master #1401 +/- ## ======================================= Coverage 97.56% 97.56% ======================================= Files 32 32 Lines 2132 2132 ======================================= Hits 2080 2080 Misses 52 52 

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

Copy link
Contributor

@n2ygkn2ygk left a comment

Choose a reason for hiding this comment

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

I'm not sure the single vs double back ticks makes a huge difference but I see you also made a bunch of other improvements, so thanks for this!

@n2ygkn2ygk merged commit fdd0594 into django-oauth:masterFeb 27, 2024
@shuuji3shuuji3 deleted the docs/clean-up-syntax-and-errors branch February 28, 2024 02:27
@shuuji3
Copy link
ContributorAuthor

shuuji3 commented Feb 28, 2024

Thanks for merging!

Actually, switching single backtick to double ones is my initial motivation to make this PR. While they are almost the same in source code text, it is rendered as italic and code-block rspectively in the Read the Docs website (in HTML, <cite>italic</cite> and <code>code-block</code>).

I think the later presentation improves the readability much better (also <cite> is not appropriate as an HTML tag).

Before

Screenshot from 2024-02-28 11-29-30
https://django-oauth-toolkit.readthedocs.io/en/stable/rest-framework/getting_started.html

After

Screenshot from 2024-02-28 11-29-25
https://django-oauth-toolkit.readthedocs.io/en/latest/rest-framework/getting_started.html#step-1-minimal-setup

Sign up for freeto 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

@shuuji3@n2ygk