Skip to content

Commit

Permalink
docs: fix referenced argument func (#79)
Browse files Browse the repository at this point in the history
<!-- 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 -->
  • Loading branch information
njzjz authored Oct 28, 2024
1 parent b8d71d8 commit c0e37b8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Then `dargs` directive will be enabled:
.. code-block:: rst
.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument
where `test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:
where `_test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:

.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument

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

Expand All @@ -36,8 +36,8 @@ To write Markdown files with `MyST-Parser <https://github.com/executablebooks/My
```{eval-rst}
.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument
```
Cross-referencing Arguments
Expand Down

0 comments on commit c0e37b8

Please sign in to comment.