Skip to content

Commit 7b63697

Browse files
[FEATURE] Apply changes as discussed in review (- WIP PR #426 -)
Changes in file README.md: * added missing comma Changes in file docs/conf.py: * "selectively" fixed a typo * Preserved the existing tab indentation as required by [CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161) for consistancy Changes in file tests/check_spelling: * updated regressions list
1 parent e377c70 commit 7b63697

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ print('Received:', message)
148148

149149
### Listening for Multicast Messages
150150

151-
* Depending on what needs to be done with received data each case will be a bit different.
151+
* Depending on what needs to be done with received data, each case will be a bit different.
152152

153153
```python3
154154
# setup console logging as example

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@
294294
# Output file base name for HTML help builder.
295295
htmlhelp_basename = "multicast_doc"
296296

297-
# -- Options for MyST markdown parser -------------------------------------------
297+
# -- Options for Mermaid diagrams -----------------------------------------------
298298
# see https://github.com/mgaitan/sphinxcontrib-mermaid?tab=readme-ov-file#markdown-support
299299

300300
# GFM style mermaid use zoom
@@ -456,7 +456,7 @@
456456

457457
def linkcode_resolve(domain, info):
458458
"""
459-
Resolves selectivly linking to GitHub source-code for the multicast module.
459+
Resolves selectively linking to GitHub source-code for the multicast module.
460460
461461
See https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html for more details.
462462

tests/check_spelling

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ declare -a SPECIFIC_TYPOS=(
158158
"excutable:executable" # from #130
159159
"bassed:based" # from #415
160160
"Historicly:Historically" # from #415
161+
"selectivly:selectively" # from #426
161162
)
162163

163164
function cleanup() {

0 commit comments

Comments
 (0)