Skip to content

Commit 2843591

Browse files
committed
Fixup RFC references
1 parent fc18a4e commit 2843591

File tree

6 files changed

+9
-14
lines changed

6 files changed

+9
-14
lines changed

protocol/specification/datainfo.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Binary large object: ``blob``
310310
311311
.. rubric:: Transport
312312

313-
As a single-line base-64 (see :RFC:`4648`) encoded JSON string.
313+
As a single-line base-64 (see :rfc:`4648`) encoded JSON string.
314314

315315
Example: ``"AA=="`` (a single, zero valued byte)
316316

@@ -460,7 +460,7 @@ As a JSON object containing the following items:
460460
List of the actual length of each dimension in the data.
461461

462462
``"blob"``
463-
The data, encoded as a single-line base64 (see :RFC:`4648`) encoded
463+
The data, encoded as a single-line base64 (see :rfc:`4648`) encoded
464464
JSON-string.
465465

466466
Example: ``{"len": [2, 3], "blob": "AACAPwAAAEAAAEBAAACAQAAAoEAAAMBA"}``

protocol/specification/discovery.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,4 @@ Implementation hints
7676
necessary.
7777

7878

79-
See also `SECoP RFC 5`_.
80-
81-
82-
.. _SECoP RFC 5: https://github.com/SampleEnvironment/SECoP/blob/master/rfcs/RFC-005-udp-discovery.rst
79+
See also :secop-rfc:`005-udp-discovery`.

protocol/specification/future.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,5 +75,5 @@ representation may be developed. This will essentially keep the structure of
7575
the messages, but replace the components of a message with shorter, binary
7676
representations.
7777

78-
Good candidates for this are CBOR (see :RFC:`7049`) and MessagePack (see
78+
Good candidates for this are CBOR (see :rfc:`7049`) and MessagePack (see
7979
https://msgpack.org/).

protocol/specification/messages.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ carriage return character (ASCII 13, ``"\r"``), which must be ignored.
77

88
A message starts with an action keyword, followed optionally by one space and a
99
specifier (not containing spaces), followed optionally by one space and a JSON
10-
value called data, which contains all remaining characters in the line.
10+
value (see :rfc:`8259`) called data, which contains all remaining characters in
11+
the line.
1112

1213
The specifier consists of a module identifier, and for most actions, followed by
1314
a colon as separator and an accessible identifier. In special cases

protocol/specification/reports.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Values are transferred as a JSON value.
7070
If an implementation uses a library which can not (de-)serialize all JSON
7171
values, the implementation can add square brackets around a JSON value,
7272
decode it and take the first element of the result. When encoding, the
73-
reverse action might be used as a workaround. See also :RFC:`7493`.
73+
reverse action might be used as a workaround. See also :rfc:`7493`.
7474

7575

7676
.. _qualifiers:

protocol/specification/transport.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ SECoP over WebSockets
101101
Since browser (i.e. HTML+JavaScript) based human interface solutions are more
102102
and more important, and JavaScript lacks traditional socket based APIs,
103103
exchanging raw SECoP messages is not an option. The best alternative is
104-
WebSockets (RFC :rfc:`6455`), which are a relatively overhead-free way of
104+
WebSockets (:rfc:`6455`), which are a relatively overhead-free way of
105105
exchanging messages between two endpoints in an arbitrary pattern.
106106

107-
See also `SECoP RFC 7`_.
107+
See also :secop-rfc:`007-websockets`.
108108

109109
Implementation in a SEC node
110110
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -160,6 +160,3 @@ they come in. A very minimal example in JavaScript::
160160

161161
// Whenever needed, send messages, for example:
162162
ws.send('change mod:param 42');
163-
164-
165-
.. _SECoP RFC 7: https://github.com/SampleEnvironment/SECoP/blob/master/rfcs/RFC-007-websockets.rst

0 commit comments

Comments
 (0)