Skip to content

Commit de1d438

Browse files
[DOCUMENTATION] Minor improvements to documentation (- WIP #413 -)
Changes in file README.md: * fixed an overlooked typo Changes in file docs/CI.md: * fixed an overlooked typo Changes in file docs/conf.py: * minor debugging of new doctests
1 parent b3802cc commit de1d438

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
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 recieved 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/CI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Most of the linting in CI/CD is performed by GitHub workflows with the exception
347347
the linter reporting (e.g., anything more than pass/fail status) is from the GitHub linter
348348
workflows. There are two noteworthy forms of feedback from the various linting automation,
349349
[code-scanning reports](https://docs.github.com/en/code-security/code-scanning), and
350-
[GitHub Anotated Messages](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-debug-message).
350+
[GitHub Annotated Messages](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-a-debug-message).
351351
All linting workflows failures result in alerts that can be reviewed with the relevant
352352
[PR via GitHub's UI](https://docs.github.com/en/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests#code-scanning-results-check-failures),
353353
albeit with different levels of details per linter workflow and target branch.

docs/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ def linkcode_resolve(domain, info):
472472
>>> _conf.linkcode_resolve is not None
473473
True
474474
>>> ignored_input = "docs.conf" # this is unchanged
475-
>>> test_text = "docs.conf" # this is resolved
475+
>>> test_text = "multicast.env" # this is resolved
476476
>>> bad_input = False # this is invalid
477477
>>> res_text = _conf.linkcode_resolve("py", info={"module": test_text})
478478
>>> res_text is not None
@@ -483,7 +483,9 @@ def linkcode_resolve(domain, info):
483483
True
484484
>>> res_text is not test_text
485485
True
486-
>>> _conf.linkcode_resolve("py", info={"module": ignored_input,}) is ignored_input
486+
>>> _conf.linkcode_resolve("py", info={"module": test_text,}) == res_text
487+
True
488+
>>> _conf.linkcode_resolve("py", info={"module": ignored_input,}) == ignored_input
487489
True
488490
>>> _conf.linkcode_resolve("py", info={"module": bad_input,}) is None
489491
True

0 commit comments

Comments
 (0)