Author ncoghlan
Recipients docs@python, ncoghlan, xtreak
Date 2018-06-17.11:40:55
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1529235655.5.0.56676864532.issue33095@psf.upfronthosting.co.za>
In-reply-to
Content
xtreak: if you're familiar with GitHub workflows, then we now accept docs and code updates as GitHub PRs: https://devguide.python.org/pullrequest/

The parts about running the tests aren't exactly relevant here, what's more relevant is building the documentation: https://devguide.python.org/documenting/#building-the-documentation

In relation to your draft patch, I think that's a good starting point, but for -c and -m, it's the current directory that gets omitted, rather than "the script's directory" (that isn't well defined when anything other than a path is passed in).

For making "-" and "<script>" hyperlinkable, you'll need to add a label definition to the Sphinx source code immediately before those description sections. I'd suggest ".. _cmdarg-dash:" and ".. _cmdarg-script:" so the resulting anchors look similar to the option ones, without being the same.
History
Date User Action Args
2018-06-17 11:40:55ncoghlansetrecipients: + ncoghlan, docs@python, xtreak
2018-06-17 11:40:55ncoghlansetmessageid: <1529235655.5.0.56676864532.issue33095@psf.upfronthosting.co.za>
2018-06-17 11:40:55ncoghlanlinkissue33095 messages
2018-06-17 11:40:55ncoghlancreate