summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-11-29 15:46:38 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-11-29 15:46:38 (GMT)
commitc4d7d8c49d3a78fc7eeb19588a9f44a74bec71e1 (patch)
treedfc190dee000bea34a84bf57ae83bdbdc2fe8b86
parente1886bfaf43383d481566b2c6a317f2f7c0b2b5d (diff)
downloadcpython-c4d7d8c49d3a78fc7eeb19588a9f44a74bec71e1.zip
cpython-c4d7d8c49d3a78fc7eeb19588a9f44a74bec71e1.tar.gz
cpython-c4d7d8c49d3a78fc7eeb19588a9f44a74bec71e1.tar.bz2
Mark up constants in sockets docs as such
-rw-r--r--Doc/library/socket.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 64b4183..ef81c4d 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -64,20 +64,20 @@ Socket addresses are represented as follows:
tuple, and the fields depend on the address type. The general tuple form is
``(addr_type, v1, v2, v3 [, scope])``, where:
- - *addr_type* is one of TIPC_ADDR_NAMESEQ, TIPC_ADDR_NAME, or
- TIPC_ADDR_ID.
- - *scope* is one of TIPC_ZONE_SCOPE, TIPC_CLUSTER_SCOPE, and
- TIPC_NODE_SCOPE.
- - If *addr_type* is TIPC_ADDR_NAME, then *v1* is the server type, *v2* is
+ - *addr_type* is one of :const:`TIPC_ADDR_NAMESEQ`, :const:`TIPC_ADDR_NAME`,
+ or :const:`TIPC_ADDR_ID`.
+ - *scope* is one of :const:`TIPC_ZONE_SCOPE`, :const:`TIPC_CLUSTER_SCOPE`, and
+ :const:`TIPC_NODE_SCOPE`.
+ - If *addr_type* is :const:`TIPC_ADDR_NAME`, then *v1* is the server type, *v2* is
the port identifier, and *v3* should be 0.
- If *addr_type* is TIPC_ADDR_NAMESEQ, then *v1* is the server type, *v2*
+ If *addr_type* is :const:`TIPC_ADDR_NAMESEQ`, then *v1* is the server type, *v2*
is the lower port number, and *v3* is the upper port number.
- If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
+ If *addr_type* is :const:`TIPC_ADDR_ID`, then *v1* is the node, *v2* is the
reference, and *v3* should be set to 0.
- If *addr_type* is TIPC_ADDR_ID, then *v1* is the node, *v2* is the
+ If *addr_type* is :const:`TIPC_ADDR_ID`, then *v1* is the node, *v2* is the
reference, and *v3* should be set to 0.
- Certain other address families (:const:`AF_BLUETOOTH`, :const:`AF_PACKET`)