Skip to content

Commit 53b4db1

Browse files
committed
docs: Add "see also" sections to docstrings
Issue-345: #345
1 parent e2e0983 commit 53b4db1

2 files changed

Lines changed: 400 additions & 58 deletions

File tree

src/_griffe/loader.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,8 @@ def resolve_aliases(
271271
def expand_exports(self, module: Module, seen: set | None = None) -> None:
272272
"""Expand exports: try to recursively expand all module exports (`__all__` values).
273273
274+
See also: [`Module.exports`][griffe.Module.exports].
275+
274276
Parameters:
275277
module: The module to recurse on.
276278
seen: Used to avoid infinite recursion.
@@ -316,6 +318,8 @@ def expand_wildcards(
316318
) -> None:
317319
"""Expand wildcards: try to recursively expand all found wildcards.
318320
321+
See also: [`Alias.wildcard`][griffe.Alias.wildcard].
322+
319323
Parameters:
320324
obj: The object and its members to recurse on.
321325
external: When true, try to load unspecified modules to expand wildcards.

0 commit comments

Comments
 (0)