Skip to content

Commit c0e37b8

Browse files
authored
docs: fix referenced argument func (#79)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated documentation to reflect the new function name `test_arguments` instead of `test_argument` for clarity and consistency. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent b8d71d8 commit c0e37b8

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/sphinx.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ Then `dargs` directive will be enabled:
1515
.. code-block:: rst
1616
1717
.. dargs::
18-
:module: dargs._test
19-
:func: test_argument
18+
:module: dargs.sphinx
19+
:func: _test_argument
2020
21-
where `test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:
21+
where `_test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:
2222

2323
.. dargs::
24-
:module: dargs._test
25-
:func: test_argument
24+
:module: dargs.sphinx
25+
:func: _test_argument
2626

2727
A :class:`list` of :class:`Argument <dargs.Argument>` is also accepted.
2828

@@ -36,8 +36,8 @@ To write Markdown files with `MyST-Parser <https://github.com/executablebooks/My
3636
3737
```{eval-rst}
3838
.. dargs::
39-
:module: dargs._test
40-
:func: test_argument
39+
:module: dargs.sphinx
40+
:func: _test_argument
4141
```
4242
4343
Cross-referencing Arguments

0 commit comments

Comments
 (0)