Skip to content

Commit b417b52

Browse files
[STYLE] Multiple Style FIxes (- PR #177 -)
Changes in file docs/Environment_Configuration.md: - Style Fixes.
1 parent 6300d50 commit b417b52

File tree

4 files changed

+18
-4
lines changed

4 files changed

+18
-4
lines changed

docs/Environment_Configuration.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Environment Configuration Module
22

33
## Overview
4-
The `multicast.env` module provides environment-based configuration for the multicast package, allowing runtime customization of network settings through environment variables.
4+
5+
The `multicast.env` module provides environment-based configuration for the multicast package,
6+
allowing runtime customization of network settings through environment variables.
57

68
## Environment Variables
79

@@ -17,6 +19,7 @@ The `multicast.env` module provides environment-based configuration for the mult
1719
## Usage
1820

1921
### Basic Configuration
22+
2023
```python
2124
import os # used to set environment
2225

@@ -36,6 +39,7 @@ import multicast
3639
```
3740

3841
### Multiple Group Configuration
42+
3943
```python
4044
# Join multiple multicast groups
4145
os.environ['MULTICAST_GROUPS'] = '224.0.0.1 224.0.0.2 224.0.0.3'
@@ -57,42 +61,52 @@ and does not actually update Multicast after import)_
5761
## Configuration Details
5862

5963
### Port Configuration
64+
6065
- Valid range: 49152-65535 (dynamic/private ports)
6166
- Invalid values trigger warning and fall back to default
6267
- Example:
68+
6369
```python
6470
os.environ['MULTICAST_PORT'] = '50000'
6571
```
6672

6773
### Group Configuration
74+
6875
- Must be valid multicast addresses (224.0.0.0/4)
6976
- Invalid addresses trigger warning and fall back to default
7077
- Example:
78+
7179
```python
7280
os.environ['MULTICAST_GROUP'] = '224.0.0.2'
7381
```
7482

7583
### TTL Configuration
84+
7685
- Valid range: 1-126 (as per RFC-1112)
7786
- Also sets socket default timeout
7887
- Example:
88+
7989
```python
8090
os.environ['MULTICAST_TTL'] = '2'
8191
```
8292

8393
### Buffer Size Configuration
94+
8495
- Must be positive integer
8596
- Invalid values trigger warning and fall back to default
8697
- Example:
98+
8799
```python
88100
os.environ['MULTICAST_BUFFER_SIZE'] = '2048'
89101
```
90102

91103
## Caveat
104+
92105
- Environment variables must be set before importing the module
93106
- Invalid values trigger warnings but won't cause failures
94107
- Changes to configuration affect all subsequent operations
95108

96109
## References
110+
97111
- [RFC-1112: Host Extensions for IP Multicasting](https://datatracker.ietf.org/doc/html/rfc1112)
98112
- [RFC-6335: IANA Port Number Registry](https://datatracker.ietf.org/doc/html/rfc6335)

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
# The short X.Y version.
117117
version = "v2.0"
118118
# The full version, including alpha/beta/rc tags.
119-
release = "v2.0.4-rc-2"
119+
release = "v2.0.4-rc-3"
120120

121121
# The language for content autogenerated by Sphinx. Refer to documentation
122122
# for a list of supported languages.

multicast/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393

9494
global __version__ # skipcq: PYL-W0604
9595

96-
__version__ = """2.0.4-rc-2"""
96+
__version__ = """2.0.4-rc-3"""
9797
"""The version of this program.
9898
9999
Minimal Acceptance Testing:

setup.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[metadata]
22
name = multicast
3-
version = 2.0.4-rc-2
3+
version = 2.0.4-rc-3
44
author = Mr. Walls
55
author_email = [email protected]
66
description = Multicast Python Module for Send/Recv Stubs.

0 commit comments

Comments
 (0)