chore: Cleanup

mkdocstrings · Jan 2, 2022 · a498db0 · a498db0
1 parent 77a3cb7
commit a498db0
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 3 deletions.
diff --git a/src/griffe/agents/inspector.py b/src/griffe/agents/inspector.py
@@ -321,7 +321,7 @@ def handle_attribute(self, node: ObjectNode, annotation: str | Name | Expression
  node: The node to inspect.
  annotation: A potentiel annotation.
  """
- # TODO
+ # TODO: to improve
  parent = self.current
  labels: set[str] = set()
 

diff --git a/src/griffe/dataclasses.py b/src/griffe/dataclasses.py
@@ -460,7 +460,6 @@ def module(self) -> Module:
  return self.parent.module
  raise ValueError
 
- # TODO: rename to top_module (for packages collection and package property)
  @cached_property
  def package(self) -> Module:
  """Return the absolute top module (the package) of this object.

diff --git a/src/griffe/docstrings/rst.py b/src/griffe/docstrings/rst.py
@@ -26,7 +26,7 @@
 
 _warn = warning(__name__)
 
-# TODO: Examples: from the documentation, I'm not sure there is a standard format for examples
+# TODO: Examples: from the documentation, we're not sure there is a standard format for examples
 PARAM_NAMES = frozenset(("param", "parameter", "arg", "argument", "key", "keyword"))
 PARAM_TYPE_NAMES = frozenset(("type",))
 ATTRIBUTE_NAMES = frozenset(("var", "ivar", "cvar"))