ansys / ansys/pyconverter-xml2py
Typographies caught in MAPDL documentation conversion
- Dominant language
- Python
- Stars
- 6
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### 🔍 Before submitting the issue
- [x] I have searched among the existing issues
- [x] I am using a Python virtual environment
### 🐞 Description of the bug
List of typographies caught in MAPDL documentation conversion:
- [ ] The end of a sentence in an OLink within a paragraph is missing.
[moper ](https://cautious-adventure-g6vqq8v.pages.github.io/version/dev/apdl/_autosummary/ansys.mapdl.core._commands.apdl.array_parameters.ArrayParameters.moper.html#ansys.mapdl.core._commands.apdl.array_parameters.ArrayParameters.moper)- check ``see APDL Math``
- [ ] In [use](https://cautious-adventure-g6vqq8v.pages.github.io/version/dev/apdl/_autosummary/ansys.mapdl.core._commands.apdl.macro_files.MacroFiles.use.html#ansys.mapdl.core._commands.apdl.macro_files.MacroFiles.use), backticks should be on the outside : " ``Name`` " -> ``"Name"``
- [ ] Partial formatting is not correct: [vabs ](https://cautious-adventure-g6vqq8v.pages.github.io/version/dev/apdl/_autosummary/ansys.mapdl.core._commands.apdl.array_parameters.ArrayParameters.vabs.html#ansys.mapdl.core._commands.apdl.array_parameters.ArrayParameters.vabs) - *V``XX`` should be ``*VXX``
### 📝 Steps to reproduce
See above
### 💻 Which operating system are you using?
Windows
### 📀 Which ANSYS version are you using?
_No response_
### 🐍 Which Python version are you using?
3.12
### 📦 Installed packages
```shell
-
```
Contributor guide
Research direction
Start by comparing the linked rendered MAPDL documentation pages for MOPER, USE, and VABS with their source conversion output. Trace the XML-to-Python documentation conversion path to find where sentence punctuation and inline backtick formatting are changed. Done means all three listed formatting issues are corrected and the affected documentation renders as expected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100