Skip to content

Commit 7c5020b

Browse files
[STYLE] Fixed more style as per review (- WIP PR #415 -)
* these changes are related to GHI #367 Changes in file .coderabbit.yaml: * related work (added missing commas) * no functional change Changes in file .github/AI_USAGE_POLICY.md: * style fixes * added missing commas Changes in file multicast/__init__.py: * related work (added missing commas) Changes in file multicast/__main__.py: * related work (added missing commas)
1 parent 378b295 commit 7c5020b

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

.coderabbit.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ reviews:
2626
[Pure BASH Bible](https://github.com/dylanaraps/pure-bash-bible) standards.
2727
- Consider [CEP-5](https://gist.github.com/reactive-firewall/3d2bd3cf37f87974df6f7bee31a05a89)
2828
custom locking conventions.
29-
- Verify all **BASH** files (e.g. are of MIME-type 'text/x-shellscript') start with an
29+
- Verify all **BASH** files (e.g., are of MIME-type 'text/x-shellscript') start with an
3030
[extensive disclaimer](https://gist.github.com/reactive-firewall/866b42d175ae3ebefcb2a5878b30ea17).
3131
3232
# Documentation Review Instructions
@@ -41,7 +41,7 @@ reviews:
4141
# Test Code Review Instructions
4242
- Ensure that test code is automated, comprehensive, and follows testing best practices.
4343
- Verify that all critical functionality is covered by tests.
44-
- Verify that minimal acceptance tests (e.g. those run by the workflow CI-MATs) are passing and
44+
- Verify that minimal acceptance tests (e.g., those run by the workflow CI-MATs) are passing and
4545
error free, pointing out any failure as below minimal acceptance (i.e. un-acceptable).
4646
- Ensure that the test coverage meets or exceeds the project's required threshold
4747
(e.g., aiming for 100% coverage as per Issue #53).
@@ -56,7 +56,7 @@ reviews:
5656
a BSD License, the Unlicence, the Apache v2 License, or that the dependency is optional. Do
5757
not assume a dependency is optional, confirm if it is or is not optional.
5858
- For **Python** code, consider [PEP 290](https://peps.python.org/pep-0290/) whenever a python
59-
(e.g. has the extension '.py') file is changed.
59+
(e.g., has the extension '.py') file is changed.
6060
request_changes_workflow: true
6161
high_level_summary: true
6262
high_level_summary_placeholder: '@coderabbitai summary'
@@ -167,7 +167,7 @@ reviews:
167167
4. Consider these 'requirements.txt' files the records of truth regarding project
168168
dependencies.
169169
5. Consider the 'requirements.txt' file in the base of the git repository
170-
(e.g. './requirements.txt') the required python dependencies regarding Multicast project
170+
(e.g., './requirements.txt') the required python dependencies regarding Multicast project
171171
dependencies.
172172
- path: tests/requirements.txt
173173
instructions: >-
@@ -192,7 +192,7 @@ reviews:
192192
1. Consider the files in the `docs/` directory tree the core/main/in-depth documentation
193193
of the project. Also consider the 'docs/**.md' files the second place to look for
194194
project documentation after the 'README.md' file.
195-
2. When reviewing the documentation files (e.g. `docs/**.md`), they should additionally
195+
2. When reviewing the documentation files (e.g., `docs/**.md`), they should additionally
196196
be linted with help from the tool `markdownlint`, pointing out any issues.
197197
3. When reviewing the documentation files in `docs/` directory, they should additionally
198198
be linted with help from the tool `languagetool`, pointing out any issues.

.github/AI_USAGE_POLICY.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ integrity.
5555
project content in future reviews.
5656
* 3.1.C Very Large PRs
5757
* For PRs exceeding 99 changed files, at least two human reviews are recommended.
58+
5859
> [!NOTE]
5960
> Currently there is only one core maintainer. Hoping to change this.
6061
@@ -88,11 +89,12 @@ integrity.
8889
* 4.1.A Review Line-by-Line
8990
* Absolutely, NO "Vibe-coding" is acceptable for this project. ALL AI-suggestions MUST be
9091
understood by at least one core maintainer (same as all other reviewed code needs to be).
92+
9193
> [!TIP]
9294
> > Good code is its own best documentation. As you're about to add a comment, ask yourself,
9395
> > "How can I improve the code so that this comment isn't needed?" Improve the code and then
9496
> > document it to make it even clearer.
95-
> - Steve McConnell
97+
> ~ Steve McConnell
9698
9799
* All AI-suggested code changes must be verified by a human maintainer (see 3.1.B).
98100
* 4.1.B Signed Commits
@@ -114,7 +116,7 @@ integrity.
114116
* The project implements a dual-approval system to help prevent single points of failure.
115117
* AI approvals are tracked separately from human approvals in the review process. Humans
116118
must be responsible for the actual merge of pull-requests.
117-
* Every user (e.g. AI, or human) must have a distinct code-signing identity (see 4.1.B).
119+
* Every user (e.g., AI, or human) must have a distinct code-signing identity (see 4.1.B).
118120
* Only human controlled identities may merge branches, or commit to the default branch directly.
119121

120122
## 5. Implementation and Compliance

multicast/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@
464464
465465
> [!IMPORTANT]
466466
> Multicast is not actually port-aware, and port filtering is instead
467-
> handled at the protocol layer (e.g. UDP) instead, and may not behave
467+
> handled at the protocol layer (e.g., UDP) instead, and may not behave
468468
> as expected for some real-world setups.
469469
470470
Minimal Testing:

multicast/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -651,7 +651,7 @@ def main(*argv) -> tuple:
651651
652652
The main(*args) function in multicast is expected to return a POSIX compatible exit code and
653653
optional detail message. Regardless of errors the result as an 'exit code' (int) is returned,
654-
even if the optional details are not (e.g. `tuple(int(exit_code), None)`).
654+
even if the optional details are not (e.g., `tuple(int(exit_code), None)`).
655655
The only exception is when the error results in exiting the process, which will exit the
656656
python runtime with the underlying return codes, instead of returning directly to the then
657657
unreachable caller. See `multicast.exceptions.exit_on_exception` for the mechanisms involved.

0 commit comments

Comments
 (0)