Skip to content

Commit

Permalink
Modify a docstring to avoid exceeding line length limit
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
diazona committed Mar 21, 2024
1 parent 6782a31 commit eee3973
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions pytest_localserver/https.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,12 @@ def __init__(self, host="localhost", port=0, key=DEFAULT_KEY, cert=DEFAULT_CERTI
def certificate(self):
"""
Returns the path to the server's SSL/TLS certificate file.
Clients can use this path to access and verify the server's identity by incorporating the certificate.
Clients can use this path to access and verify the server's identity by
incorporating the certificate.
Note: Do not rely on having a stable filesystem path for the returned certificate path across different versions or test runs.
.. note::
Do not rely on having a stable filesystem path for the returned
certificate path across different versions or test runs.
"""
return self._cert

Expand Down

0 comments on commit eee3973

Please sign in to comment.