8000 Merge branch 'main' of github.com:mkdocstrings/python · ElementalWarrior/python@bb85ad3 · GitHub
[go: up one dir, main page]
Skip to content

Commit bb85ad3

Browse files
pawamoypawamoy
committed
Merge branch 'main' of github.com:mkdocstrings/python
2 parents 3d838a9 + 004b18d commit bb85ad3

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

‎docs/usage/customization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ and the Jinja context available in their scope.
302302
Available context:
303303

304304
- `config`: The handler configuration (dictionary).
305-
- `module`: The [Module][griffe.dataclasses.Module] instance.
305+
- `module`: The [Module][griffe.Module] instance.
306306

307307
#### `class.html`
308308

@@ -319,7 +319,7 @@ Available context:
319319
Available context:
320320

321321
- `config`: The handler configuration (dictionary).
322-
- `class`: The [Class][griffe.dataclasses.Class] instance.
322+
- `class`: The [Class][griffe.Class] instance.
323323

324324
#### `function.html`
325325

@@ -333,7 +333,7 @@ Available context:
333333
Available context:
334334

335335
- `config`: The handler configuration (dictionary).
336-
- `function`: The [Function][griffe.dataclasses.Function] instance.
336+
- `function`: The [Function][griffe.Function] instance.
337337

338338
#### `attribute.html`
339339

@@ -346,7 +346,7 @@ Available context:
346346
Available context:
347347

348348
- `config`: The handler configuration (dictionary).
349-
- `attribute`: The [Attribute][griffe.dataclasses.Attribute] instance.
349+
- `attribute`: The [Attribute][griffe.Attribute] instance.
350350

351351
#### Docstring sections
352352

@@ -368,7 +368,7 @@ and `docstring/yields.html`:
368368

369369
Available context:
370370

371-
- `section`: The [DocstringSection][griffe.docstrings.dataclasses.DocstringSection] instance (see `DocstringSection*` subclasses).
371+
- `section`: The [DocstringSection][griffe.DocstringSection] instance (see `DocstringSection*` subclasses).
372372

373373
### Syntax highlight in signatures
374374

‎src/mkdocstrings_handlers/python/handler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ class PythonHandler(BaseHandler):
162162
163163
Attributes: Docstrings options:
164164
docstring_style (str): The docstring style to use: `google`, `numpy`, `sphinx`, or `None`. Default: `"google"`.
165-
docstring_options (dict): The options for the docstring parser. See parsers under [`griffe.docstrings`][].
165+
docstring_options (dict): The options for the docstring parser. See [docstring parsers](https://mkdocstrings.github.io/griffe/reference/docstrings/) and their options in Griffe docs.
166166
docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `"table"`.
167167
merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
168168
show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.

0 commit comments

Comments
 (0)
0