Adjust the names to ignore.

canonical · Oct 6, 2023 · 3e16ea6 · 3e16ea6
1 parent b14fd7c
commit 3e16ea6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -73,23 +73,25 @@ def _compute_navigation_tree(context):
 # domain name if present. Example entries would be ('py:func', 'int') or
 # ('envvar', 'LD_LIBRARY_PATH').
 nitpick_ignore = [
-    ('py:class', '_AddressDict'),
+    ('py:class', 'ops.model._AddressDict'),
     ('py:class', '_ChangeDict'),
     ('py:class', '_CheckInfoDict'),
+    ('py:class', 'ops.model._ConfigOption'),
+    ('py:class', 'ops.pebble._FileLikeIO'),
     ('py:class', '_FileInfoDict'),
-    ('py:class', '_IOSource'),
-    ('py:class', '_NetworkDict'),
+    ('py:class', 'ops.pebble._IOSource'),
+    ('py:class', 'ops.model._NetworkDict'),
     ('py:class', '_ProgressDict'),
     ('py:class', '_Readable'),
     ('py:class', '_RelationMetaDict'),
     ('py:class', '_ResourceMetaDict'),
-    ('py:class', '_ServiceInfoDict'),
+    ('py:class', 'ops.pebble._ServiceInfoDict'),
     ('py:class', '_StorageMetaDict'),
-    ('py:class', '_SystemInfoDict'),
+    ('py:class', 'ops.pebble._SystemInfoDict'),
     ('py:class', '_TaskDict'),
     ('py:class', '_TextOrBinaryIO'),
     ('py:class', '_WarningDict'),
-    ('py:class', '_WebSocket'),
+    ('py:class', 'ops.pebble._WebSocket'),
     ('py:class', '_Writeable'),
     ('py:class', 'ops.model._ModelBackend'),
     ('py:class', 'ops.model._ModelCache'),

diff --git a/ops/pebble.py b/ops/pebble.py
@@ -172,7 +172,6 @@ def close(self): ...  # noqa
 
 
 class _FileLikeIO(Protocol[typing.AnyStr]):  # That also covers TextIO and BytesIO
-    """An object that provides both read() and write() methods for any string type."""
     def read(self, __n: int = ...) -> typing.AnyStr: ...  # for BinaryIO  # noqa
     def write(self, __s: typing.AnyStr) -> int: ...  # noqa
     def __enter__(self) -> typing.IO[typing.AnyStr]: ...  # noqa