-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Fix docstring syntax errors #1312
Conversation
Since docstrings are strings, a '\n' will insert a newline. If the documentation should read '\n', the backslash should be escaped.
The epytext syntax requires a list to be indented.
Otherwise the epytext parser will complain about the indentation.
CircleCI refuses to let me view the details of the test failure unless I hand it read/write access to all my repositories, which I'm obviously not going to agree to. Is this a bug? If not, I think it's a completely unacceptable policy, both in terms of privacy and security. Update: exarkun was kind enough to copy-paste the error message on IRC; it was about the missing news fragment. I still think it's a problem though that CircleCI won't show details unless you hand it a bunch of permissions it doesn't need. |
I fixed the unrelated lint errors in a separate commit. |
These are in close proximity to, but not actually part of, the changed docstrings.
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 looks OK
@mthuurne in future when you merge your PR to Twisted's trunk, you need to manually add these three lines to the merge commit message:
This auto-closes the Trac ticket, and updates https://twistedmatrix.com/highscores See: https://twistedmatrix.com/trac/wiki/ReviewProcess#Authors:Howtomergethechangetotrunk You can also look at some other merge commits in Twisted for examples. |
Sorry, this was my first time merging a commit for Twisted; I'll do that next time. |
It's OK, the Twisted dev process is a bit complicated for newcomers, but once you get the hang of it, it is OK. |
This removes some noise from the pydoctor logging, so actual problems will stand out more.
Contributor Checklist:
I have updated the automated tests.Only docstrings are changed.review
to the keywords field in Trac, and putting a link to this PR in the comment; it shows up in https://twisted.reviews/ now.