From c0e37b8780b947f0ed41be066c56aa3bc8163a0b Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Mon, 28 Oct 2024 01:22:59 -0400 Subject: [PATCH] docs: fix referenced argument func (#79) ## Summary by CodeRabbit - **Documentation** - Updated documentation to reflect the new function name `test_arguments` instead of `test_argument` for clarity and consistency. --- docs/sphinx.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index fcfc62c..891f047 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -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 `. The documentation will be rendered as: +where `_test_argument` returns an :class:`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 ` is also accepted. @@ -36,8 +36,8 @@ To write Markdown files with `MyST-Parser