ansys / ansys/pyconverter-xml2py

Enabling configurable notes and raw texts at the begin of specified commands

Open
#387 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### 📝 Description of the feature

The same way a ``warning`` can be added from the ``config.yaml`` file, ``.. note::`` and raw text could be accepted at the top of a method docstring.

Mentioned for the first time in https://github.com/ansys/pymapdl/pull/3385#discussion_r1920277225

### 💡 Steps for implementing the feature

_No response_

### 🔗 Useful links and references

_No response_

Contributor guide

Open the contributing guide

Research direction

The issue names config.yaml and method docstrings but provides no files or tests. Start by tracing how warning entries from config.yaml are handled during XML-to-Python conversion, then determine where leading note directives and raw text should be accepted. Done means both forms can be configured at the beginning of specified method docstrings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.