Skip to content

Link to Discourse first in "Help with Documentation" section #1043

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Link to Discourse first in "Help with Documentation" section #1043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions documentation/help-documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,10 @@ and :ref:`maintenance <maintbranch>` branches at https://docs.python.org/dev/.
The in-development and recent maintenance branches are rebuilt once per day.

If you would like to be more involved with documentation, consider subscribing
to the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list and the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_,
where user issues are raised and documentation toolchain, projects, and standards
are discussed.
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list where user issues are raised and documentation toolchain,
projects, and standards are discussed.
Copy link
Member

Choose a reason for hiding this comment

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

Whitespace nit for the linter:

Suggested change
projects, and standards are discussed.
projects, and standards are discussed.

Comment on lines +39 to +42
Copy link
Member

@CAM-Gerlach CAM-Gerlach Feb 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Fix trailing whitespace (causing the lint failure), and fix line breaks to minimize diffs and keep the line lengths at least roughly consistent.

Suggested change
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list where user issues are raised and documentation toolchain,
projects, and standards are discussed.
to the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_ and the
`docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_ mailing list
where user issues are raised and documentation toolchain, projects, and standards
are discussed.

Copy link
Member

Choose a reason for hiding this comment

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

Hey @Mariatta , do we just want to commit this and merge, or do you have other ideas here? Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Because it seems the branch was mistakenly pushed to the upstream repo rather than the user's fork (as the user was an admin, the current protections against this didn't work—I've tested and confirmed an improved version on python/core-workflow#460 that would prevent accidents like this going forward), @Mariatta or one of her fellow admins will have to commit this suggestion.



Helping with documentation issues
Expand Down