Skip to content

Commit 83987cf

Browse files
committed
Fix some references
1 parent 1999b87 commit 83987cf

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

protocol/specification/messages.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ identifier length is limited (<=63 characters).
109109
- accessible names of a module (including the group entries of those
110110
parameters) - each module has its own scope
111111
- properties
112-
- names of elements in a :ref:`struct` (each struct has its own scope)
113-
- names of variants in an :ref:'enum` (each enum has its own scope)
112+
- names of elements in a :ref:`struct <struct>` (each struct has its own scope)
113+
- names of variants in an :ref:`enum <enum>` (each enum has its own scope)
114114
- names of qualifiers
115115

116116
SECoP defined names are usually lowercase, though that is not a restriction
@@ -885,7 +885,7 @@ Essentially this boils down to:
885885
#) same for error class (i.e. treat ``WrongType:MustBeInt`` as ``WrongType``,
886886
ignoring the ``:MustBeInt`` part)
887887
#) upon parsing a value, when you know it should be one element from an
888-
:ref:`enum` (which SHOULD be transported as integer), if you find a string
888+
:ref:`enum <enum>` (which SHOULD be transported as integer), if you find a string
889889
instead and that string is one of the names from the Enum, use that entry.
890890
#) check newer versions of the specification and check the issues as well, as
891891
the above may change

protocol/specification/modules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ to be unique within an SEC node, accessible names have to be unique within a
3131
module. There are two basic types of accessibles: parameters and commands.
3232

3333
Module and accessible names should be in English (incl. acronyms), using only
34-
ASCII letters and digits and some additional characters (see :ref:`messages`).
34+
ASCII letters and digits and some additional characters (see :doc:`messages`).
3535
The maximum name length is 63 characters.
3636

3737
Definition: Parameter

protocol/specification/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ SECoP Node Structure
1818
- SECoP is a communication protocol with a client-server model. The server is
1919
called the "SEC node".
2020

21-
- Each SEC node consists of one or more :ref:`Modules`. These represent the
21+
- Each SEC node consists of one or more :ref:`modules`. These represent the
2222
main interface for interacting with the hardware.
2323

2424
- Each of these modules can have static values which are known at startup and
@@ -60,8 +60,8 @@ SECoP Node Structure
6060
Messages
6161
--------
6262

63-
The communication between client and server builds upon :ref:`messages
64-
<messages>` which are transferred between SEC node and client.
63+
The communication between client and server builds upon :doc:`messages`
64+
which are transferred between SEC node and client.
6565

6666
As an introduction, we will look at the general message structure, and the
6767
messages :ref:`*IDN? <message-identification>`, :ref:`describe

0 commit comments

Comments
 (0)