Skip to content

Commit 8c0d6f8

Browse files
committed
docs(sphinx-ext): Use generic examples in docstrings
Replace tmuxp-specific examples with generic "myapp" in doctests and comments.
1 parent 6cdd947 commit 8c0d6f8

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

docs/_ext/sphinx_argparse_neo/renderer.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def _extract_id_prefix(prog: str) -> str:
122122
Parameters
123123
----------
124124
prog : str
125-
The program name, potentially with subcommand (e.g., "tmuxp load").
125+
The program name, potentially with subcommand (e.g., "myapp sub").
126126
127127
Returns
128128
-------
@@ -131,12 +131,12 @@ def _extract_id_prefix(prog: str) -> str:
131131
132132
Examples
133133
--------
134-
>>> ArgparseRenderer._extract_id_prefix("tmuxp load")
135-
'load'
136-
>>> ArgparseRenderer._extract_id_prefix("tmuxp")
134+
>>> ArgparseRenderer._extract_id_prefix("myapp sub")
135+
'sub'
136+
>>> ArgparseRenderer._extract_id_prefix("myapp")
137137
''
138-
>>> ArgparseRenderer._extract_id_prefix("vcspull sync")
139-
'sync'
138+
>>> ArgparseRenderer._extract_id_prefix("prog cmd")
139+
'cmd'
140140
>>> ArgparseRenderer._extract_id_prefix("myapp sub cmd")
141141
'sub-cmd'
142142
"""
@@ -191,7 +191,7 @@ def render(self, parser_info: ParserInfo) -> list[nodes.Node]:
191191
result.append(program_node)
192192

193193
# Extract ID prefix from prog for unique section IDs
194-
# e.g., "tmuxp load" -> "load", "myapp" -> ""
194+
# e.g., "myapp sub" -> "sub", "myapp" -> ""
195195
id_prefix = self._extract_id_prefix(parser_info.prog)
196196

197197
# Add Usage section as sibling (for TOC visibility)

docs/_ext/sphinx_argparse_neo/utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ def escape_rst_emphasis(text: str) -> str:
6868
6969
Examples
7070
--------
71-
>>> escape_rst_emphasis('tmuxp load "my-*"')
72-
'tmuxp load "my-\\*"'
71+
>>> escape_rst_emphasis('myapp load "my-*"')
72+
'myapp load "my-\\*"'
7373
>>> escape_rst_emphasis("plain text")
7474
'plain text'
7575
>>> escape_rst_emphasis("*emphasis* is ok")

0 commit comments

Comments
 (0)