formatting

Author: maksimdrachov

src/pycyphal2/__init__.py

@@ -5,15 +5,15 @@
 
 Supports various transports such as Ethernet (UDP) and CAN FD with optional redundancy.
 
-## Installation
+# Installation
 
 Optional features inside the brackets can be removed if not needed; see `pyproject.toml` for the full list:
 
 ```
 pip install 'pycyphal2[udp,pythoncan]'
 ```
 
-## Usage
+# Usage
 
 Set up a transport, make a node, publish and subscribe:
 
@@ -48,7 +48,7 @@ async def main():
 
 There exist 4 kinds of topic names in Cyphal, used effectively they allow the developer to split up complex systems into smaller sub-systems, simplifying development and debugging.
 
-#### 1. Relative Name
+### Relative Name
 
 A relative name is a name that does not start with '/' or `~/`.
 
@@ -77,7 +77,7 @@ async def main():
 | `speed`           | `motor_3` | `robot` | `motor_3/speed`              |
 | `speed`           | `motor_4` | `robot` | `motor_4/speed`              |
 
-#### 2. Absolute Name
+### Absolute Name
 
 An absolute name starts with `/`.
 
@@ -103,7 +103,7 @@ async def main():
 | `/log`                | `cpu`           | `robot` | `/log`             |
 | `/battery_voltage`    | `battery_1`     | `robot` | `/battery_voltage` |
 
-#### 3. Homeful Name
+### Homeful Name
 
 A homeful name starts with `~` of `~/`.
 
@@ -123,7 +123,7 @@ async def main():
 
 Example: We want to configure an antenna to transmit at a specific frequency. The antenna node has a `~/config/frequency` topic that we can publish to.
 
-#### 4. Pattern Name
+### Pattern Name
 
 A pattern name contains wildcard `*` (matches any _single_ name segment)
 
@@ -143,7 +143,7 @@ async def main():
 Example: `*/battery_pct` to subscribe to all nodes publishing battery data, of which there may be multiple per vehicle.
 'logs/>' to subscribe to all topics publishing under '/logs' which may contain 'log_info', 'log_warning', 'log_error' topics.
 
-#### Extra functions
+### Extra functions
 
 *Topping* is the process by which a unique subject ID is assigned upon initialization.
 For some applications that require a high level of reliability, determinism is required and can be achieved by using `#` to pin a topic to a specific subject ID.
@@ -186,7 +186,7 @@ async def main():
 
 See also :meth:`Node.remap`.
 
-### Publish
+## Publish
 
 Publication is best-effort by default. Pass `reliable=True` when publishing to retry delivery until
 acknowledged by every known subscriber or until the deadline; if the remote side does not acknowledge in time,
@@ -197,7 +197,7 @@ async def main():
 await pub(Instant.now() + 1.0, b"payload", reliable=True)
 ```
 
-### Subscribe
+## Subscribe
 
 Subscriptions normally yield messages as soon as they arrive. Set `reordering_window` [seconds] on
 :meth:`Node.subscribe` to allow delaying out-of-order messages to reconstruct the original publication order.
@@ -219,7 +219,7 @@ async def main():
     print(topic.name, captures)  # [('engine', 1)], where 1 is the pattern segment index
 ```
 
-### RPC & streaming
+## RPC & streaming
 
 RPC is layered directly on top of pub/sub. Use :meth:`Publisher.request` to publish a message that expects
 responses, and use :attr:`Arrival.breadcrumb` on the subscriber side to send a unicast reply back to the requester.
@@ -239,7 +239,7 @@ async def main():
 await arrival.breadcrumb(Instant.now() + 1.0, b"chunk-2", reliable=True)
 ```
 
-### Topic pinning
+## Topic pinning
 
 Topics may be pinned to a specific subject-ID using `name#1234` to bypass automatic assignment.
 This is useful for applications where a high degree of determinism is required and for Cyphal/CAN v1.0 interoperability.
@@ -255,7 +255,7 @@ async def main():
 Old Cyphal/CAN v1.0 nodes do not participate in the topic discovery protocol,
 so topics joined only by such nodes are not discoverable by pattern subscribers.
 
-## Remarks
+# Remarks
 
 Cyphal does not define a serialization format. Previous versions used to define the DSDL format but it has been
 extracted into an independent project, and Cyphal was made serialization-agnostic in v1.1+.