8000 Fix the docs · mimoccc/circuitpython@543940e · GitHub
[go: up one dir, main page]

Skip to content

Commit 543940e

Browse files
committed
Fix the docs
1 parent 6f0d62d commit 543940e

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

shared-bindings/mdns/RemoteService.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@
3333
#include "shared-bindings/mdns/RemoteService.h"
3434

3535
//| class RemoteService:
36-
//| """Encapsulates information about a remote service that was found during a query. This
36+
//| """Encapsulates information about a remote service that was found during a search. This
3737
//| object may only be created by a `mdns.Server`. It has no user-visible constructor."""
3838
//|
3939

4040
//| def __init__(self) -> None:
41-
//| """Cannot be instantiated directly. Use `mdns.Server.query`."""
41+
//| """Cannot be instantiated directly. Use `mdns.Server.find`."""
4242
//| ...
4343
//|
4444

shared-bindings/mdns/Server.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ const mp_obj_property_t mdns_server_instance_name_obj = {
135135
//| """Find all locally available remote services with the given service type and protocol.
136136
//|
137137
//| This doesn't allow for direct hostname lookup. To do that, use
138-
//| `socketpool.SocketPool.getaddrinfo()`
138+
//| `socketpool.SocketPool.getaddrinfo()`.
139139
//|
140140
//| :param str service_type: The service type such as "_http"
141141
//| :param str protocol: The service protocol such as "_tcp"

shared-bindings/socketpool/SocketPool.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ STATIC mp_obj_t socketpool_socketpool_socket(size_t n_args, const mp_obj_t *pos_
9191
}
9292
MP_DEFINE_CONST_FUN_OBJ_KW(socketpool_socketpool_socket_obj, 1, socketpool_socketpool_socket);
9393

94-
//| def getaddrinfo(host: str, port: int, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0) -> Tuple[int, int, int, str, Tuple[str, int]]:
95-
//| """Gets the address information for a hostname and port
94+
//| def getaddrinfo(host: str, port: int, family: int = 0, type: int = 0, proto: int = 0, flags: int = 0) -> Tuple[int, int, int, str, Tuple[str, int]]:
95+
//| """Gets the address information for a hostname and port
9696
//|
97-
//| Returns the appropriate family, socket type, socket protocol and
98-
//| address information to call socket.socket() and socket.connect() with,
99-
//| as a tuple."""
100-
//| ...
97+
//| Returns the appropriate family, socket type, socket protocol and
98+
//| address information to call socket.socket() and socket.connect() with,
99+
//| as a tuple."""
100+
//| ...
101101
//|
102102
STATIC mp_obj_t socketpool_socketpool_getaddrinfo(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
103103
enum { ARG_host, ARG_port, ARG_family, ARG_type, ARG_proto, ARG_flags };

0 commit comments

Comments
 (0)
0