ansys / ansys/pyconverter-xml2py
Handling link containing command reference
- Dominant language
- Python
- Stars
- 6
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
In ``VGET``, a link contains a command reference.
link + command reference:
```
*VLEN
```
Is it a typo in MAPDL documentation or should it be addressed properly?
----------
Current rendering is:
```
`\*VLEN `_ :ref:`vlen`
```

------------
Ideally rendering should be one of the following:
- ```
`\*VLEN `_ / :ref:`vlen`
```
- ```
:ref:`vlen`
```
- ```
`\*VLEN `_
```
Contributor guide
Research direction
Start by locating the VGET XML containing the link and command reference, then trace how the converter renders that combination. Compare the generated output with the three alternatives in the issue; done means the command reference is rendered consistently without the duplicated or malformed link output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, xml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100