[DOCUMENTATION] improved documentation slightly

Changes in file tests/test_fuzz.py:
 * improved wording for onlyIfHasHypothesis docstring

Changes in file docs/FAQ.md:
 * minor changes

Changes in file multicast/__init__.py:
 * Added note that some dunder can be ignored by users
 * Added trivial doctests to some dunder
 * other minor improvements to documentation

Author: reactive-firewall

.github/workflows/codeql-analysis.yml

@@ -44,7 +44,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@28deaeda66b76a05916b6923827895f2b14ab387  # v3.28.16
+      uses: github/codeql-action/init@60168efe1c415ce0f5521ea06d5c2062adbeed1b  # v3.28.17
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -55,7 +55,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@28deaeda66b76a05916b6923827895f2b14ab387  # v3.28.16
+      uses: github/codeql-action/autobuild@60168efe1c415ce0f5521ea06d5c2062adbeed1b  # v3.28.17
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -69,4 +69,4 @@ jobs:
     #    make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@28deaeda66b76a05916b6923827895f2b14ab387  # v3.28.16
+      uses: github/codeql-action/analyze@60168efe1c415ce0f5521ea06d5c2062adbeed1b  # v3.28.17

.github/workflows/scorecard.yml

@@ -53,6 +53,6 @@ jobs:
           retention-days: 5
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@28deaeda66b76a05916b6923827895f2b14ab387  # v3.28.16
+        uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b  # v3.28.17
         with:
           sarif_file: results.sarif

.github/workflows/shellcheck.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           persist-credentials: false
       - name: Shellcheck Scan
-        uses: reactive-firewall/shellcheck-scan@89ae54cd2b9d19a34e72712d986ebb21d8521dd3 # v0
+        uses: reactive-firewall/shellcheck-scan@ececa8940e6bfbf5bf1426dd9292b9b25367c14a # v0
         with:  # optional arguments
           match: 'tests/check_* **/*.sh'
           publish-artifacts: true

README.md

@@ -1,6 +1,6 @@
 # Multicast Python Module
 
-![Mcast Logo](Logo.svg)
+![Mcast Logo](https://github.com/reactive-firewall/multicast/blob/stable/Logo.svg)
 
 ## Introduction
 
@@ -47,12 +47,60 @@ applications, making it straightforward to work with multicast sockets.
 
 ## Installation
 
-Install the package using pip:
+Install the package using `pip`:
+
+```bash
+pip install multicast
+```
+
+<details><summary>Other Methods</summary>
+
+There are many ways to install the module besides using `pip`, but unless you have a specific need,
+using `pip` is recommended for most users.
+
+### PEP-668 and externally-managed-environment installs
+
+Users using Homebrew may require additional flags to use `pip`:
+
+```bash
+python3 -m pip install --use-pep517 --break-system-packages --user 'multicast>=2.0.8'
+```
+
+### Install from Source
+
+*Source builds require development tools including (but not limited to): `git`, and `make`*
+
+```bash
+# clone the multicast source repository
+git clone "https://github.com/reactive-firewall/multicast.git" multicast
+cd multicast
+# switch to the stable branch
+git checkout stable
+# build the multicast module
+make -f Makefile build
+# install the build
+make user-install
+# Optionally check the install
+python3 -m multicast --version
+```
+
+### Developer builds
+
+> [!WARNING]
+> **Development Builds** *(e.g. Cutting-Edge)* are not intended as full-fleged releases, however
+> updates to the Development Builds are more frequent than releases.
+
+### Legacy egg style install
+
+> [!WARNING]
+> **Egg Style Builds** *(Deprecated)* are not supported after version `2.1` :shrug:
 
 ```bash
 pip install -e "git+https://github.com/reactive-firewall/multicast.git#egg=multicast"
 ```
 
+</details>
+
 ## Getting Started
 
 Below are basic examples to help you start using the `multicast` package.
@@ -160,4 +208,4 @@ This project is licensed under the MIT License. See the
 [LICENSE.md](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md) file for
 details.
 
-[![License - MIT](https://img.shields.io/github/license/reactive-firewall/multicast.svg?maxAge=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/CI.md

@@ -169,4 +169,4 @@ make clean ; # cleans up for next test
 
 #### Copyright (c) 2021-2025, Mr. Walls
 
-[MIT License](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/Environment_Configuration.md

@@ -115,4 +115,4 @@ and does not actually update Multicast after import)_
 
 ### Copyright (c) 2024-2025, Mr. Walls
 
-[![License - MIT](https://img.shields.io/github/license/reactive-firewall/multicast.svg?maxAge=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/Exception_Guide.md

@@ -336,4 +336,4 @@ provide a better experience for users interacting with the software.
 
 ### Copyright (c) 2024-2025, Mr. Walls
 
-[![License - MIT](https://img.shields.io/github/license/reactive-firewall/multicast.svg?maxAge=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/FAQ.md

@@ -233,7 +233,7 @@ work as far as this Multicast module is concerned.
   documentation site.
 
 * However, if one still wishes to build the documentation manually, there is a `make` target
-  specifically for this:
+  specifically for building from source:
 
   ```bash
   make build-docs
@@ -245,6 +245,8 @@ work as far as this Multicast module is concerned.
   to the specific commit you're working on, set the `DOCS_BUILD_REF` environment variable:
 
   ```bash
+  # git clone ...
+  # git checkout <specific commit>
   # shellcheck disable=SC2155
   export DOCS_BUILD_REF=$("${GIT:-git}" rev-parse --verify HEAD)
   make build-docs  # or your own documentation build command
@@ -257,4 +259,4 @@ work as far as this Multicast module is concerned.
 
 #### Copyright (c) 2021-2025, Mr. Walls
 
-[MIT License](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/USAGE.md

@@ -102,11 +102,11 @@ I begin with it.
 CLI should work like so:
 
 ```plain
-multicast [-h|--help] [--use-std] [--daemon] (SAY|RECV|HEAR)
+multicast [[-h|--help]|[--version] [--use-std] [--daemon] (SAY|RECV|HEAR)
     [-h|--help]
     [--port PORT]
     [--iface IFACE]
-    [-m MESSAGE|--message MESSAGE]
+    [-m MESSAGE|--message MESSAGE|--pipe]
     [--group BIND_GROUP]
     [--groups [JOIN_MCAST_GROUPS ...]]
 ```
@@ -119,8 +119,9 @@ and echo functions of a 1-to-1 connection.
 The `SAY` command is used to send data messages via multicast datagrams.
 
 * Note: the `--message` flag is expected with the `SAY` command;
-  if not provided, it behaves like `NOOP`.
+  if neither `--pipe` nor `--messages` are provided, `SAY` behaves like `NOOP`.
 * Note: the `--daemon` flag has no effect on the `SAY` command.
+* Note: the `--pipe` option reads message from stdin (added in v2.1.0, equivalent to `--message -`).
 
 ### `RECV`
 
@@ -149,4 +150,4 @@ received multicast datagrams.
 
 #### Copyright (c) 2021-2025, Mr. Walls
 
-[MIT License](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)
+[![License - MIT](https://img.shields.io/pypi/l/multicast?cacheSeconds=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

docs/conf.py

@@ -125,7 +125,7 @@
 # The short X.Y version.
 version = "v2.0"
 # The full version, including alpha/beta/rc tags.
-release = "v2.0.8"
+release = "v2.0.9"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.