taipy
taipy copied to clipboard
[🐛 BUG] tgb object descriptions don't render properly in linters
What went wrong? 🤔
When using a linter to check the documentation of a Taipy tgb object such as tgb.text, the description does not render properly: for example it shows
instead of breaking the line. Here is an example:
Expected Behavior
The description of tgb objects should break lines and display code fragments properly, here is an example from pandas:
The issue might come from using HTML to write descriptions instead of Markdown which would explain why
is not rendered
Steps to Reproduce Issue
Using a linter in VSCode or equivalent, write:
import taipy.gui.builder as tgb
tgb.text()
Hover over text
to see the broken description
Expected behavior
No response
Screenshots
No response
Runtime Environment
No response
Browsers
No response
OS
Windows
Version of Taipy
3.1.1
Additional Context
No response
Acceptance Criteria
- [X] Ensure new code is unit tested, and check code coverage is at least 90%.
- [X] Create a related issue in taipy-doc for documentation and Release Notes if relevant.
Code of Conduct
- [X] I have checked the existing issues.
- [ ] I am willing to work on this issue (optional)