-
-
Notifications
You must be signed in to change notification settings - Fork 32.8k
Improved the writing documentation page. #18714
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes looking good, a few small things to suggest. I think you should explain the rationale for the change in how commands are displayed? Seems a bit arbitrary (unless this is part of a docs styleguide I’m not aware of)
``_build/linkcheck/output.txt`` and ``_build/linkcheck/output.json``. | ||
|
||
.. admonition:: Be careful with the time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like having that note but the heading isn’t super clear to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have suggestions for a clearer title?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be a warning without a title
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sense to me. I removed the title, and updated the commit.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be a warning without a title
@sarahboyce I just find out that the admonition
directive require a title :)
...writing-documentation.txt:196: ERROR: Error in "admonition" directive:
1 argument(s) required, 0 supplied.
So I added a tittle again in the code because the use of the note
directive is discouraged in the same documents.
To improve readability, use
.. admonition:: Descriptive title
rather tha.. note::
I like having that note but the heading isn’t super clear to me.
@thibaudcolas I tried to add a clearer title
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think warnings can have no title (.. warning::
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think warnings can have no title (
.. warning::
)
Using .. warning::
seems a good idea, thanks, I checked that it's widely used in the code. I just updated the PR. Thanks.
ad0d14b
to
eac1bc2
Compare
TL;DR I simply applied the presentation format of the 'make html' command to the other commands presented on the page. Trying to read the guide to contributing to Django documentation from scratch as if I were a new contributor, I noticed that the command to generate the html documentation was very obvious, clear and compatible even for Windows users. The other commands presented on the page, however, were immersed in the text, not easy to locate and with the only variant for Unix users. |
b4d5f24
to
e4a96bc
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you also link to <coding-style-pre-commit>
) in line 309.
e4a96bc
to
782a987
Compare
Thanks, I did it. |
782a987
to
68f6cb8
Compare
68f6cb8
to
9739c71
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @pauloxnet ⭐ these are nice updates
Trac ticket number
"N/A"
Branch description
Improved the writing documentation page.
Checklist
main
branch.