v2.0.x Chore - improve FAQ.md

[reactive-firewall]

docs/FAQ.md (3)

135-140: Consider using more specific exception handling

Instead of catching all exceptions, it would be more helpful to catch specific exceptions that might occur during multicast operations. This helps users better understand and handle potential issues.

 try:
     multicast.__main__.McastDispatch().doStep(["SAY", _fixture_SAY_args])
     # Hint: use a loop to repeat or different arguments to vary message.
-except Exception:
+except (multicast.MulticastError, ValueError, RuntimeError) as e:
     p.join()
-    raise RuntimeError("multicast seems to have failed.")
+    raise RuntimeError(f"Multicast operation failed: {str(e)}")

---

202-204: Fix grammar and style in deployment considerations

Consider these improvements for better readability:

-While developers and network admistrators must consider other factors in the real world deployment,
-it is fair to say any free port in the dynamic or "ephemeral" port range of `49152`-`65535` should
-work so far as this Multicast module is concerned.
+While developers and network administrators must consider other factors in real-world deployments,
+it is fair to say any free port in the dynamic or "ephemeral" port range of `49152`-`65535` should
+work as far as this Multicast module is concerned.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~202-~202: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...tors must consider other factors in the real world deployment, it is fair to say any free ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

231-234: Fix grammar in documentation building instructions

Consider these improvements:

-* Typicly the documentation will be automatically build by CI/CD and posted to the official
+* Typically, the documentation will be automatically built by CI/CD and posted to the official
   documentation site.

-* However if one still wishes to manually build the documentation, there is a make target for this:
+* However, if one still wishes to build the documentation manually, there is a make target for this:

🧰 Tools

🪛 LanguageTool

[grammar] ~231-~231: Consider using either the past participle “built” or the present participle “building” here.
Context: ...the documentation will be automatically build by CI/CD and posted to the official d...

(BEEN_PART_AGREEMENT)

---

[uncategorized] ~234-~234: A comma may be missing after the conjunctive/linking adverb ‘However’.
Context: ...o the official documentation site. * However if one still wishes to manually build t...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

---

[style] ~234-~234: Style-wise, it’s not ideal to insert an adverb (‘manually’) in the middle of an infinitive construction (‘to build’). Try moving the adverb to avoid split infinitives.
Context: ...mentation site. * However if one still wishes to manually build the documentation, there is a make target for this: ``...

(SPLIT_INFINITIVE)

Originally posted by @coderabbitai[bot] in #184 (review)

---

Also:

docs/FAQ.md (2)

40-40: Fix grammar in the setup assumption

Add a comma before 'and' as it connects two independent clauses.

-(assuming `multicast` is set up, installed and you want to listen on 0.0.0.0)
+(assuming `multicast` is set up, installed, and you want to listen on 0.0.0.0)

🧰 Tools

🪛 LanguageTool

[uncategorized] ~40-~40: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ssuming multicast is set up, installed and you want to listen on 0.0.0.0) ```bash...

(COMMA_COMPOUND_SENTENCE)

---

227-227: Fix grammar and style in documentation building section

Address the following issues:

1. Use "built" instead of "build" (past participle)
2. Add a comma after "However"
3. Rearrange the split infinitive

-Typicly the documentation will be automatically build by CI/CD and posted to the official
+Typically the documentation will be automatically built by CI/CD and posted to the official
-* However if one still wishes to manually build the documentation, there is a make target for this:
+* However, if one still wishes to build the documentation manually, there is a make target for this:

Also applies to: 230-230

🧰 Tools

🪛 LanguageTool

[grammar] ~227-~227: Consider using either the past participle “built” or the present participle “building” here.
Context: ...the documentation will be automatically build by CI/CD and posted to the official d...

(BEEN_PART_AGREEMENT)