Skip to content

Commit fc18a4e

Browse files
committed
Consistent heading casing
1 parent abd8ad6 commit fc18a4e

File tree

14 files changed

+36
-36
lines changed

14 files changed

+36
-36
lines changed

protocol/specification/accessibles.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Parameters and Commands
1+
Parameters and commands
22
=======================
33

44
A typical module has several accessibles associated with it. An accessible is
@@ -14,7 +14,7 @@ The following section describes the currently predefined parameters and
1414
commands. This list will be extended continuously in new SECoP versions.
1515

1616

17-
Basic Parameters
17+
Basic parameters
1818
~~~~~~~~~~~~~~~~
1919

2020
.. parameter:: value
@@ -239,7 +239,7 @@ Error handling
239239
other ERROR state before returning ``done <module>:clear_errors``.
240240

241241

242-
Coupled Modules
242+
Coupled modules
243243
~~~~~~~~~~~~~~~
244244

245245
.. parameter:: controlled_by
@@ -346,7 +346,7 @@ Coupled Modules
346346
parameter with the name of the controlling module).
347347

348348

349-
Limits and Offset
349+
Limits and offset
350350
~~~~~~~~~~~~~~~~~
351351

352352
.. parameter:: target_limits

protocol/specification/additional.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Additional Topics
1+
Additional topics
22
=================
33

44
.. toctree::

protocol/specification/classes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _interface-classes:
22

3-
Interface Classes
3+
Interface classes
44
=================
55

66
Interface classes let the ECS determine the functionality of a module from its
@@ -23,7 +23,7 @@ of the base classes listed below.
2323
even conform to the Readable class.
2424

2525

26-
Base Classes
26+
Base classes
2727
------------
2828

2929
.. baseclass:: Communicator

protocol/specification/descriptive.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _descriptive-data:
22

3-
Properties: Self-Description
4-
============================
3+
Properties and descriptive data
4+
===============================
55

66
This section explains the "descriptive data", also called "structure report",
77
i.e. the completely self-describing metadata sent by the SEC node in response to
@@ -75,14 +75,14 @@ Example of a complete description (JSON has been pretty-printed for clarity):
7575
:alt: accessible_description ::= '{' property+ '}'
7676

7777

78-
SEC Node Description
78+
SEC node description
7979
--------------------
8080

8181
The descriptive data is a JSON object with nested sub-hierarchies. The
8282
properties on the top level describe the SEC node.
8383

8484

85-
Mandatory SEC Node Properties
85+
Mandatory SEC node properties
8686
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8787

8888
.. node-property:: modules
@@ -113,7 +113,7 @@ Mandatory SEC Node Properties
113113
``\n`` for linebreaks.
114114

115115

116-
Optional SEC Node Properties
116+
Optional SEC node properties
117117
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
118118

119119
.. node-property:: firmware
@@ -140,10 +140,10 @@ Optional SEC Node Properties
140140

141141
.. _module-description:
142142

143-
Module Description
143+
Module description
144144
------------------
145145

146-
Mandatory Module Properties
146+
Mandatory module properties
147147
~~~~~~~~~~~~~~~~~~~~~~~~~~~
148148

149149
.. mod-property:: accessibles
@@ -167,7 +167,7 @@ Mandatory Module Properties
167167
"Drivable"]``.
168168

169169

170-
Optional Module Properties
170+
Optional module properties
171171
~~~~~~~~~~~~~~~~~~~~~~~~~~
172172

173173
.. mod-property:: visibility
@@ -351,10 +351,10 @@ Optional Module Properties
351351

352352
.. _accessible-description:
353353

354-
Parameter and Command Description
354+
Parameter and command description
355355
---------------------------------
356356

357-
Mandatory Properties
357+
Mandatory properties
358358
~~~~~~~~~~~~~~~~~~~~
359359

360360
.. acc-property:: description
@@ -376,7 +376,7 @@ Mandatory Properties
376376
the latter have a datainfo of ``{"type": "command", ...}``.
377377

378378

379-
Mandatory Parameter Properties
379+
Mandatory parameter properties
380380
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381381

382382
.. acc-property:: readonly
@@ -385,7 +385,7 @@ Mandatory Parameter Properties
385385
or not.
386386

387387

388-
Optional Properties
388+
Optional properties
389389
~~~~~~~~~~~~~~~~~~~
390390

391391
.. acc-property:: group
@@ -478,7 +478,7 @@ Optional Properties
478478
| :issue:`075 New messages check and checked`
479479
480480

481-
Optional Parameter Properties
481+
Optional parameter properties
482482
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
483483

484484
.. acc-property:: constant
@@ -491,7 +491,7 @@ Optional Parameter Properties
491491
The value given here must conform to the data type of the accessible.
492492

493493

494-
Custom Properties
494+
Custom properties
495495
-----------------
496496

497497
Custom properties may further augment accessibles, modules or the SEC node

protocol/specification/discovery.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
UDP Discovery Protocol
1+
UDP discovery protocol
22
======================
33

44
Due to the flexibility of the SECoP node system, it is quite likely for multiple
@@ -10,7 +10,7 @@ All SEC nodes that wish to support autodiscovery open a UDP socket listening on
1010
port 10767. Upon receiving a packet on this port, they reply with a packet
1111
containing the required information to connect to this node.
1212

13-
Format of the Packets
13+
Format of the packets
1414
---------------------
1515

1616
From client to nodes
@@ -37,7 +37,7 @@ From node to client
3737

3838
Further keys in the object can be specified later.
3939

40-
Node Self-Announcement
40+
Node self-announcement
4141
----------------------
4242

4343
Furthermore, a SEC node can self-announce by broadcasting UDP packets to port

protocol/specification/future.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _future-compatibility:
22

3-
Future Compatibility
3+
Future compatibility
44
====================
55

66
Notes for implementors of the current specification
@@ -60,7 +60,7 @@ design:
6060
* Define additional features, listed in an additional property.
6161

6262

63-
Message Handling
63+
Message handling
6464
----------------
6565

6666
For this, see :ref:`this section <message-compat>`.

protocol/specification/messages/activation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
``activate``, ``deactivate``: Controlling events
2-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1+
``activate``, ``deactivate``: Control events
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33

44
.. message:: [request] activate [<module>]
55
[reply] active [<module>]

protocol/specification/messages/commands.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
``do``: execute commands
1+
``do``: Execute commands
22
~~~~~~~~~~~~~~~~~~~~~~~~
33

44
.. message:: [request] do <module>:<command> [<value>]

protocol/specification/messages/errors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _error-reply:
22

3-
``error_*``: Error Replies
3+
``error_*``: Error replies
44
--------------------------
55

66
Contains an error class from the list below as its second item (the specifier).
@@ -26,7 +26,7 @@ Example:
2626
2727
.. _error-classes:
2828

29-
Error Classes
29+
Error classes
3030
-------------
3131

3232
Error classes are divided into two groups: persisting errors and retryable

protocol/specification/messages/heartbeat.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
``ping``: heartbeat
1+
``ping``: Heartbeat
22
~~~~~~~~~~~~~~~~~~~
33

44
.. message:: [request] ping [<token>]

0 commit comments

Comments
 (0)