Skip to content

Commit eee3973

Browse files
committed
Modify a docstring to avoid exceeding line length limit
A long line in this docstring was causing the flake8 pre-commit check to fail, so I edited the comment to be compliant. I shortened the lines to about 80 characters for consistency with other comments, even though that's more of a change than is strictly required to pass flake8. With this change, we can start requiring pre-commit to pass for all merges. I also changed a note to use Restructured Text syntax, for compatibility with other docstrings in the project.
1 parent 6782a31 commit eee3973

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

pytest_localserver/https.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,12 @@ def __init__(self, host="localhost", port=0, key=DEFAULT_KEY, cert=DEFAULT_CERTI
126126
def certificate(self):
127127
"""
128128
Returns the path to the server's SSL/TLS certificate file.
129-
Clients can use this path to access and verify the server's identity by incorporating the certificate.
129+
Clients can use this path to access and verify the server's identity by
130+
incorporating the certificate.
130131
131-
Note: Do not rely on having a stable filesystem path for the returned certificate path across different versions or test runs.
132+
.. note::
133+
Do not rely on having a stable filesystem path for the returned
134+
certificate path across different versions or test runs.
132135
"""
133136
return self._cert
134137

0 commit comments

Comments
 (0)