[docs] [issue36258] Incorrect docstring of the ssl module

Ofek Lev report at bugs.python.org
Sun Mar 10 18:19:05 EDT 2019


New submission from Ofek Lev <ofekmeister at gmail.com>:

The docstring refers to the function `fetch_server_certificate` that no longer exists. Context from https://github.com/python/cpython/pull/12168#issuecomment-469488585:

"""
In the commit on 8/28/2007, the ssl.py module was first added and it contained the fetch_server_certificate() function. That function was removed with commit r57680 on 8/30/2007. The function get_server_certificate() was added in commit r58164 on 9/18/2007.
...
Additionally, there are more than just 2 functions now, so it seems to me that the entire module docstring should be reviewed and updated to reflect the current state of the module or else it should be removed since it hasn't been kept in sync.
"""

----------
assignee: docs at python
components: Documentation
messages: 337639
nosy: Ofekmeister, cheryl.sabella, docs at python
priority: normal
severity: normal
status: open
title: Incorrect docstring of the ssl module
type: behavior
versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6, Python 3.7, Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue36258>
_______________________________________


More information about the docs mailing list