Skip to content

Commit

Permalink
ci: Don't use parameter headings insiders feature since it breaks in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Jul 14, 2024
1 parent 39a1174 commit 0477db5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/guide/users/loading.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Reusing the same loader will also help resolving aliases across different packag

## Search paths

To specify in which directories Griffe should search for packages and modules, you can use the `search_paths` parameter on both the [`load` function][griffe.load(search_paths)] and the [`GriffeLoader` class][griffe.GriffeLoader(search_paths)].
To specify in which directories Griffe should search for packages and modules, you can use the `search_paths` parameter on both the [`load` function][griffe.load] and the [`GriffeLoader` class][griffe.GriffeLoader].

=== "`load`"

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/users/navigating.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ Each object has an optional [`docstring`][griffe.Object.docstring] attached to i

Docstrings can be parsed against several [docstring-styles](../../reference/docstrings.md), which are micro-formats that allow documenting things such as parameters, returned values, raised exceptions, etc..

When loading a package, it is possible to specify the docstring style to attach to every docstring (see [`griffe.load(docstring_parser)`][griffe.load(docstring_parser)]). Accessing the [`parsed`][griffe.Docstring.parsed] field of a docstring will use this style to parse the docstring and return a list of [docstring sections][advanced-api-sections]. Each section has a `value` whose shape depend on the section kind. For example, parameter sections have a list of parameter representations as value, while a text section only has a string as value.
When loading a package, it is possible to specify the docstring style to attach to every docstring (see the `docstring_parser` parameter of [`griffe.load`][griffe.load]). Accessing the [`parsed`][griffe.Docstring.parsed] field of a docstring will use this style to parse the docstring and return a list of [docstring sections][advanced-api-sections]. Each section has a `value` whose shape depend on the section kind. For example, parameter sections have a list of parameter representations as value, while a text section only has a string as value.

After a package is loaded, it is still possible to change the style used for specific docstrings by either overriding their [`parser`][griffe.Docstring.parser] and [`parser_options`][griffe.Docstring.parser_options] attributes, or by calling their [`parse()`][griffe.Docstring.parse] method with a different style:

Expand Down
2 changes: 1 addition & 1 deletion src/_griffe/finder.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class ModuleFinder:
The module finder is generally not used directly.
Each [`GriffeLoader`][griffe.GriffeLoader] instance creates its own module finder instance.
The finder can be configured when instantiating the loader
thanks to the loader [`search_paths`][griffe.GriffeLoader(search_paths)] parameter.
thanks to the [loader][griffe.GriffeLoader]'s `search_paths` parameter.
"""

accepted_py_module_extensions: ClassVar[list[str]] = [".py", ".pyc", ".pyo", ".pyd", ".pyi", ".so"]
Expand Down

0 comments on commit 0477db5

Please sign in to comment.