You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[STYLE] Documentation style fixes for the FAQ updates (- WIP PR #429 -)
Changes in file docs/FAQ.md:
* style fixes
* multiple minor rewordings
* added list of some key project policies for contributors
Changes in file docs/USAGE.md:
* style fixes
* simplified some code examples even more
**Explanation of the Command-Line Options**<!-- Not a header due to repeated usage -->
52
+
53
+
| Option | Description |
54
+
|--------|-------------|
44
55
|`--daemon`| This option runs the multicast listener as a background daemon. |
45
56
|`--use-std`| This specifies the action to take when any output is produced. In this case, it uses the standard output to print received messages instead of the default to just log messages. |
46
57
|`HEAR`| This specifies the action to take. In this case, it will _receive_ multicast. |
47
58
|`--port 59595`| This sets the UDP port number to `59595`, which is used to identify/filter the multicast messages that will be accepted. |
48
59
|`--group 224.0.0.1`| This specifies the multicast group address to join. You can replace `224.0.0.1` with your desired multicast group address. |
49
60
50
-
##### Steps to Run
61
+
**Steps to Run**<!-- Not a header due to repeated usage -->
51
62
52
63
1. Open your terminal.
53
64
2. Ensure you have the multicast module installed and accessible.
**Explanation of the Command-Line Options**<!-- Not a header due to repeated usage -->
114
+
115
+
| Option | Description |
116
+
|--------|-------------|
104
117
|`SAY`| This specifies the action to take. In this case, it will _transmit_ multicast. |
105
118
|`--group 224.0.0.1`| This specifies the multicast group address to transmit messages to. You can replace `224.0.0.1` with your desired multicast group address. |
106
119
|`--port 59595`| This sets the UDP port number to `59595`, which is used by other members of the multicast group to help identify/filter the multicast messages to accept. |
107
120
|`--message`| This specifies the rest of the input is to be the message to transmit. |
108
121
|`"Hello World!"`| This specifies the multicast message content to _transmit_. In this case, it is the greeting "Hello World!" |
109
122
110
-
##### Step-by-step
123
+
**Steps to Run**<!-- Not a header due to repeated usage -->
111
124
112
125
1. Open your terminal.
113
126
2. Ensure you have the multicast module installed and accessible.
@@ -127,7 +140,6 @@ functionality to ensure that messages are being transmitted and received correct
127
140
# Optional setup console logging
128
141
import logging
129
142
multicast_logging_sink = logging.getLogger()
130
-
handler = logging.StreamHandler()
131
143
multicast_logging_sink.setLevel(logging.INFO) # increase default logging from multicast module
132
144
handler = logging.StreamHandler() # example trivial log handler
0 commit comments