This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: :func:`socket` in socket.rst links to socket module, not socket.socket
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: docs@python, ezio.melotti, python-dev, zach.ware
Priority: normal Keywords: patch

Created on 2013-04-15 18:06 by zach.ware, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
socket_func_link.diff zach.ware, 2013-04-15 18:06 Patch against default review
socket_func_link_2.7.diff zach.ware, 2013-04-15 18:07 Patch against 2.7
Messages (5)
msg187009 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2013-04-15 18:06
In Doc/library/socket.rst, :func:`socket` links to #module-socket, not #socket.socket.  The attached patch changes all occurances of :func:`socket` to :func:`~socket.socket`, except the first one which keeps the explicit module name (no ~).
msg187011 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-15 18:17
I think :func:`.socket` should work too.
msg187013 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2013-04-15 18:51
So it does.  Would you like a new pair of patches?  It is just a search-and-replace from ":func:`socket`" to ":func:`.socket`".
msg187128 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-04-17 01:12
New changeset 7041401699e9 by Ezio Melotti in branch '3.3':
#17740: fix links to the socket function.  Initial patch by Zachary Ware.
http://hg.python.org/cpython/rev/7041401699e9

New changeset b6802d2a6c4e by Ezio Melotti in branch 'default':
#17740: merge with 3.3.
http://hg.python.org/cpython/rev/b6802d2a6c4e

New changeset 053d55ab495c by Ezio Melotti in branch '2.7':
#17740: fix links to the socket function.  Initial patch by Zachary Ware.
http://hg.python.org/cpython/rev/053d55ab495c
msg187129 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-17 01:13
Fixed, thanks for the report and the patches!
History
Date User Action Args
2022-04-11 14:57:44adminsetgithub: 61940
2013-04-17 01:13:51ezio.melottisetstatus: open -> closed
resolution: fixed
messages: + msg187129

stage: patch review -> resolved
2013-04-17 01:12:33python-devsetnosy: + python-dev
messages: + msg187128
2013-04-15 18:51:43zach.waresetmessages: + msg187013
2013-04-15 18:17:39ezio.melottisetnosy: + ezio.melotti
messages: + msg187011

assignee: docs@python -> ezio.melotti
stage: patch review
2013-04-15 18:07:04zach.waresetfiles: + socket_func_link_2.7.diff
2013-04-15 18:06:48zach.warecreate