Skip to content

Commit f1f8eb7

Browse files
[DOCUMENTATION] Minor fixes for regressions from last set of changes 🙈
Changes in file README.md: * minor rewording for readability Changes in file multicast/__init__.py: * minor fixes for doctests * related work
1 parent 1a5a71f commit f1f8eb7

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ applications, making it straightforward to work with multicast sockets.
1111
## Features
1212

1313
- **Easy Multicast Communication**: Send and receive messages over multicast networks with
14-
simple interfaces.
15-
- **Command-Line Tools**: Includes command-line utilities for quick multicast operations.
14+
simple `Python` interfaces.
15+
- **Command-Line Tools**: Includes command-line utilities for quick multicast prototyping.
1616
- **Cross-Python Compatibility**: Designed to work with multiple Python versions.
1717
- **Support for UDP**: Works with UDP via IPv4 multicast addresses.
1818

@@ -53,7 +53,7 @@ Install the package using `pip`:
5353
pip install multicast
5454
```
5555

56-
<details><summary>Other Methods</summary>
56+
<details><summary>Alternative Methods</summary>
5757

5858
There are many ways to install the module besides using `pip`, but unless you have a specific need,
5959
using `pip` is recommended for most users.

multicast/__init__.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,9 @@
273273
274274
Key Features:
275275
- Easy-to-use python interfaces for multicast communication.
276-
- transmition via multicast.send
277-
- high-level reciving via multicast.hear for building custom multicast services.
278-
- low-level reciving via multicast.recv for advanced non-blocking use-cases.
276+
- transmission via multicast.send
277+
- high-level receiving via multicast.hear for building custom multicast services.
278+
- low-level receiving via multicast.recv for advanced non-blocking use-cases.
279279
- Command-line tools for quick multicast prototyping.
280280
- Support for UDP multicast (currently IPv4 Only) via Python's built-in socket module.
281281
- Compliance with RFC-6335 for dynamic/private port ranges.
@@ -398,7 +398,7 @@
398398
399399
> [!CAUTION]
400400
> This value is NOT related to the actual packet size, the python socket module, and
401-
> underlaying OS, firmware and even some hardware will handle all of that. If you need
401+
> underlying OS, firmware and even some hardware will handle all of that. If you need
402402
> to change buffers you are better off focusing on changing the underlying MTU of the
403403
> entire network infrastructure instead (albeit that may not be possible for most users).
404404
@@ -712,7 +712,7 @@ class mtool(abc.ABC):
712712
>>> _multicast.mtool is not None
713713
True
714714
>>> type(_multicast.mtool) #doctest: +ELLIPSIS
715-
<...multicast.mtool...>
715+
<...abc.ABC...>
716716
>>> hasattr(_multicast.mtool, "__abstractmethods__")
717717
True
718718
>>>
@@ -725,6 +725,7 @@ class mtool(abc.ABC):
725725
>>> hasattr(_multicast.mtool, "__abstractmethods__")
726726
True
727727
>>> len(_multicast.mtool.__abstractmethods__) >= int(2)
728+
True
728729
>>> "doStep" in _multicast.mtool.__abstractmethods__
729730
True
730731
>>> "setupArgs" in _multicast.mtool.__abstractmethods__
@@ -739,12 +740,13 @@ class mtool(abc.ABC):
739740
>>> hasattr(_multicast.mtool, "__abstractmethods__")
740741
True
741742
>>> len(_multicast.mtool.__abstractmethods__) >= int(2)
743+
True
742744
>>> "doStep" in _multicast.mtool.__abstractmethods__
743745
True
744746
>>> "setupArgs" in _multicast.mtool.__abstractmethods__
745747
True
746748
>>> _test_dir_fixture = dir(_multicast.mtool)
747-
>>> _test_dir_fixture is not None:
749+
>>> _test_dir_fixture is not None
748750
True
749751
>>> "buildArgs" in _test_dir_fixture
750752
True

0 commit comments

Comments
 (0)