Skip to content

Commit c57bcb7

Browse files
committed
Standardize links to RFC.
There were 70 links to https://datatracker.ietf.org/doc/html/ vs. 15 links https://www.rfc-editor.org/rfc/. Also :rfc:`....` links to https://datatracker.ietf.org/doc/html/ by default. While https://www.ietf.org/process/rfcs/#introduction says: > The RFC Editor website is the authoritative site for RFCs. the IETF Datatracker looks a bit better and has more information.
1 parent 5f34e27 commit c57bcb7

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

docs/faq/common.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ How do I respond to pings?
131131
If you are referring to Ping_ and Pong_ frames defined in the WebSocket
132132
protocol, don't bother, because websockets handles them for you.
133133

134-
.. _Ping: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.5.2
135-
.. _Pong: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.5.3
134+
.. _Ping: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.5.2
135+
.. _Pong: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.5.3
136136

137137
If you are connecting to a server that defines its own heartbeat at the
138138
application level, then you need to build that logic into your application.

docs/howto/extensions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ During the opening handshake, WebSocket clients and servers negotiate which
77
extensions_ will be used with which parameters. Then each frame is processed
88
by extensions before being sent or after being received.
99

10-
.. _extensions: https://www.rfc-editor.org/rfc/rfc6455.html#section-9
10+
.. _extensions: https://datatracker.ietf.org/doc/html/rfc6455.html#section-9
1111

1212
As a consequence, writing an extension requires implementing several classes:
1313

docs/project/changelog.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1487,7 +1487,7 @@ New features
14871487

14881488
* Added support for providing and checking Origin_.
14891489

1490-
.. _Origin: https://www.rfc-editor.org/rfc/rfc6455.html#section-10.2
1490+
.. _Origin: https://datatracker.ietf.org/doc/html/rfc6455.html#section-10.2
14911491

14921492
.. _2.0:
14931493

docs/reference/extensions.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The WebSocket protocol supports extensions_.
88
At the time of writing, there's only one `registered extension`_ with a public
99
specification, WebSocket Per-Message Deflate.
1010

11-
.. _extensions: https://www.rfc-editor.org/rfc/rfc6455.html#section-9
11+
.. _extensions: https://datatracker.ietf.org/doc/html/rfc6455.html#section-9
1212
.. _registered extension: https://www.iana.org/assignments/websocket/websocket.xhtml#extension-name
1313

1414
Per-Message Deflate

docs/topics/design.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -173,16 +173,16 @@ differences between a server and a client:
173173
- `closing the TCP connection`_: the server closes the connection immediately;
174174
the client waits for the server to do it.
175175

176-
.. _client-to-server masking: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.3
177-
.. _closing the TCP connection: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.5.1
176+
.. _client-to-server masking: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.3
177+
.. _closing the TCP connection: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.5.1
178178

179179
These differences are so minor that all the logic for `data framing`_, for
180180
`sending and receiving data`_ and for `closing the connection`_ is implemented
181181
in the same class, :class:`~protocol.WebSocketCommonProtocol`.
182182

183-
.. _data framing: https://www.rfc-editor.org/rfc/rfc6455.html#section-5
184-
.. _sending and receiving data: https://www.rfc-editor.org/rfc/rfc6455.html#section-6
185-
.. _closing the connection: https://www.rfc-editor.org/rfc/rfc6455.html#section-7
183+
.. _data framing: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5
184+
.. _sending and receiving data: https://datatracker.ietf.org/doc/html/rfc6455.html#section-6
185+
.. _closing the connection: https://datatracker.ietf.org/doc/html/rfc6455.html#section-7
186186

187187
The :attr:`~protocol.WebSocketCommonProtocol.is_client` attribute tells which
188188
side a protocol instance is managing. This attribute is defined on the

docs/topics/keepalive.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Keepalive in websockets
3333
To avoid these problems, websockets runs a keepalive and heartbeat mechanism
3434
based on WebSocket Ping_ and Pong_ frames, which are designed for this purpose.
3535

36-
.. _Ping: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.5.2
37-
.. _Pong: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.5.3
36+
.. _Ping: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.5.2
37+
.. _Pong: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.5.3
3838

3939
It sends a Ping frame every 20 seconds. It expects a Pong frame in return within
4040
20 seconds. Else, it considers the connection broken and terminates it.
@@ -98,7 +98,7 @@ at regular intervals. Usually they expect Text_ frames rather than Ping_ frames,
9898
meaning that you must send them with :attr:`~asyncio.connection.Connection.send`
9999
rather than :attr:`~asyncio.connection.Connection.ping`.
100100

101-
.. _Text: https://www.rfc-editor.org/rfc/rfc6455.html#section-5.6
101+
.. _Text: https://datatracker.ietf.org/doc/html/rfc6455.html#section-5.6
102102

103103
In websockets, such keepalive mechanisms are considered as application-level
104104
because they rely on data frames. That's unlike the protocol-level keepalive

docs/topics/logging.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Instead, when running as a server, websockets logs one event when a
3535
`connection is established`_ and another event when a `connection is
3636
closed`_.
3737

38-
.. _connection is established: https://www.rfc-editor.org/rfc/rfc6455.html#section-4
39-
.. _connection is closed: https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.4
38+
.. _connection is established: https://datatracker.ietf.org/doc/html/rfc6455.html#section-4
39+
.. _connection is closed: https://datatracker.ietf.org/doc/html/rfc6455.html#section-7.1.4
4040

4141
By default, websockets doesn't log an event for every message. That would be
4242
excessive for many applications exchanging small messages at a fast rate. If

0 commit comments

Comments
 (0)