Skip to content

Commit

Permalink
docs: Add "see also" sections to docstrings
Browse files Browse the repository at this point in the history
Issue-345: #345
  • Loading branch information
pawamoy committed Dec 26, 2024
1 parent e2e0983 commit 53b4db1
Show file tree
Hide file tree
Showing 2 changed files with 400 additions and 58 deletions.
4 changes: 4 additions & 0 deletions src/_griffe/loader.py
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ def resolve_aliases(
def expand_exports(self, module: Module, seen: set | None = None) -> None:
"""Expand exports: try to recursively expand all module exports (`__all__` values).
See also: [`Module.exports`][griffe.Module.exports].
Parameters:
module: The module to recurse on.
seen: Used to avoid infinite recursion.
Expand Down Expand Up @@ -316,6 +318,8 @@ def expand_wildcards(
) -> None:
"""Expand wildcards: try to recursively expand all found wildcards.
See also: [`Alias.wildcard`][griffe.Alias.wildcard].
Parameters:
obj: The object and its members to recurse on.
external: When true, try to load unspecified modules to expand wildcards.
Expand Down
Loading

0 comments on commit 53b4db1

Please sign in to comment.