Skip to content
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

Merged
merged 7 commits into from
Jun 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/twisted/cred/test/test_cred.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,12 +323,12 @@ class CheckersMixin(object):
and deny specified credentials.

Subclasses must provide
- C{getCheckers} which returns a sequence of
L{checkers.ICredentialChecker}
- C{getGoodCredentials} which returns a list of 2-tuples of
credential to check and avaterId to expect.
- C{getBadCredentials} which returns a list of credentials
which are expected to be unauthorized.
- C{getCheckers} which returns a sequence of
L{checkers.ICredentialChecker}
- C{getGoodCredentials} which returns a list of 2-tuples of
credential to check and avaterId to expect.
- C{getBadCredentials} which returns a list of credentials
which are expected to be unauthorized.
"""

@defer.inlineCallbacks
Expand Down
2 changes: 1 addition & 1 deletion src/twisted/mail/test/test_pop3.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# See LICENSE for details.

"""
Test cases for Ltwisted.mail.pop3} module.
Test cases for L{twisted.mail.pop3} module.
"""


Expand Down
9 changes: 6 additions & 3 deletions src/twisted/names/test/test_dns.py
Original file line number Diff line number Diff line change
Expand Up @@ -4211,9 +4211,10 @@ def fakeToMessage(*args, **kwargs):



class EDNSMessageEqualityTests(ComparisonTestsMixin, unittest.SynchronousTestCase):
class EDNSMessageEqualityTests(ComparisonTestsMixin,
unittest.SynchronousTestCase):
"""
Tests for equality between L(dns._EDNSMessage} instances.
Tests for equality between L{dns._EDNSMessage} instances.

These tests will not work with L{dns.Message} because it does not use
L{twisted.python.util.FancyEqMixin}.
Expand Down Expand Up @@ -4924,9 +4925,11 @@ def __repr__(self):

class CompactReprTests(unittest.SynchronousTestCase):
"""
Tests for L[dns._compactRepr}.
Tests for L{dns._compactRepr}.
"""

messageFactory = Foo

def test_defaults(self):
"""
L{dns._compactRepr} omits field values and sections which have the
Expand Down
Empty file.
12 changes: 6 additions & 6 deletions src/twisted/python/test/test_shellcomp.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ class ZshScriptTestMixin(object):
Integration test helper to show that C{usage.Options} classes can have zsh
completion functions generated for them without raising errors.

In your subclasses set a class variable like so:
In your subclasses set a class variable like so::

# | cmd name | Fully Qualified Python Name of Options class |
#
generateFor = [('conch', 'twisted.conch.scripts.conch.ClientOptions'),
('twistd', 'twisted.scripts.twistd.ServerOptions'),
]
# | cmd name | Fully Qualified Python Name of Options class |
#
generateFor = [('conch', 'twisted.conch.scripts.conch.ClientOptions'),
('twistd', 'twisted.scripts.twistd.ServerOptions'),
]

Each package that contains Twisted scripts should contain one TestCase
subclass which also inherits from this mixin, and contains a C{generateFor}
Expand Down
2 changes: 1 addition & 1 deletion src/twisted/python/test/test_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ def test_bytes(self):

class PasswordTestingProcessProtocol(ProcessProtocol):
"""
Write the string C{"secret\n"} to a subprocess and then collect all of
Write the string C{"secret\\n"} to a subprocess and then collect all of
its output and fire a Deferred with it when the process ends.
"""
def connectionMade(self):
Expand Down
5 changes: 3 additions & 2 deletions src/twisted/web/test/test_xml.py
Original file line number Diff line number Diff line change
Expand Up @@ -817,8 +817,9 @@ class BrokenHTMLTests(TestCase):
"""
Tests for when microdom encounters very bad HTML and C{beExtremelyLenient}
is enabled. These tests are inspired by some HTML generated in by a mailer,
which breaks up very long lines by splitting them with '!\n '. The expected
behaviour is loosely modelled on the way Firefox treats very bad HTML.
which breaks up very long lines by splitting them with '!\\n '.
The expected behaviour is loosely modelled on the way Firefox treats very
bad HTML.
"""

def checkParsed(self, input, expected, beExtremelyLenient=1):
Expand Down