Skip to content

Update stale docstrings in AsyncZeroconf #1079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bdraco merged 4 commits into from
Jun 21, 2022
Merged

Update stale docstrings in AsyncZeroconf #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86f5372
Update stale docstrings in AsyncZeroconf
bdraco Jun 21, 2022
f259751
Update zeroconf/asyncio.py
bdraco Jun 21, 2022
894b90a
bump
bdraco Jun 21, 2022
f825559
Merge branch 'stale_docs_strings' of github.com:bdraco/python-zerocon…
bdraco Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# version: 1.2
# version: 1.3

.PHONY: all virtualenv
MAX_LINE_LENGTH=110
Expand Down
7 changes: 4 additions & 3 deletions zeroconf/asyncio.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ class AsyncZeroconf:

Supports registration, unregistration, queries and browsing.

The async version is currently a wrapper around the sync version
with I/O being done in the executor for backwards compatibility.
The async version is currently a wrapper around Zeroconf which
is now also async. It is expected that an asyncio event loop
is already running before creating the AsyncZeroconf object.
"""

def __init__(
Expand All @@ -145,7 +146,7 @@ def __init__(
zc: Optional[Zeroconf] = None,
) -> None:
"""Creates an instance of the Zeroconf class, establishing
multicast communications, listening and reaping threads.
multicast communications, and listening.

:param interfaces: :class:`InterfaceChoice` or a list of IP addresses
(IPv4 and IPv6) and interface indexes (IPv6 only).
Expand Down