-
-
Notifications
You must be signed in to change notification settings - Fork 842
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.
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
The Docs Discourse forum is the preferred way. I reordered the sentence so that the discourse forum is mentioned first.
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. |
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.
Whitespace nit for the linter:
projects, and standards are discussed. | |
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. |
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.
Fix trailing whitespace (causing the lint failure), and fix line breaks to minimize diffs and keep the line lengths at least roughly consistent.
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. |
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.
Hey @Mariatta , do we just want to commit this and merge, or do you have other ideas here? Thanks!
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.
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.
Thanks for the offer @safwansamsudeen , but if @Mariatta 's busy, we can simply commit my suggestion here to achieve the same thing, without all the overhead of a whole other PR and without stripping author/attribution information. However, your help on the other PR you commented would be much appreciated, and a new clean branch is indeed the approach that would be required there, if you're up for it. Thanks! |
Thanks for the ping and reminding me of this PR. I will take a look once I'm back on the computer. |
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.
PR LGTM with @CAM-Gerlach suggestion applied.
Sounds good! |
I recreated the PR using my own fork in #1118. |
Okay, thanks. Did it not allow you to commit the above suggestion? I thought it would as an admin (since it allowed you to push initially), but maybe not. Anyway, would you ,omd cleaning up these two stale branches, as well as the other two merged ones? The branches page lists all four, and you should be able to delete them with one click from there (assuming |
The Docs Discourse forum is the preferred way.
I reordered the sentence so that the discourse forum is mentioned first.