https://bugs.kde.org/show_bug.cgi?id=442900
Bug ID: 442900
Summary: [Feature request] Optional reStructuredText syntax
highlighting for inline Python documentation
Product: frameworks-syntax-highlighting
Version: 5.86.0
Platform: Other
OS: Linux
Status: REPORTED
Severity: wishlist
Priority: NOR
Component: syntax
Assignee: kwrite-bugs-n...@kde.org
Reporter: geisse...@gmail.com
CC: walter.von.entfer...@posteo.net
Target Milestone: ---
SUMMARY
Many Python projects use inline code documentation with sphinx-autodoc, since
this is a lot less maintenance work than separate code documentation.
This way, it is much easier to keep code and docs consistent, especially as
method parameter headers are generated automatically.
STEPS TO REPRODUCE
1. Open a Python file with inline Sphinx reStructuredText documentation in Kate
OBSERVED RESULT
The Python code is syntax-highlighted. The inline rst markup is not
highlighted, however.
EXPECTED RESULT
It would be nice to have optional rst syntax highlighting for inline code
documentation indicated with `""" documentation text here """`.
SOFTWARE/OS VERSIONS
Operating System: KDE neon 5.22
KDE Plasma Version: 5.22.5
KDE Frameworks Version: 5.86.0
Qt Version: 5.15.3
Kernel Version: 5.11.0-36-generic (64-bit)
Graphics Platform: Wayland
Processors: 4 × Intel® Core™ i5-3570K CPU @ 3.40GHz
Memory: 7.2 GiB of RAM
Graphics Processor: Mesa DRI Intel® HD Graphics 4000
ADDITIONAL INFORMATION
Perhaps this idea is a bit far-fetched and/or hard to implement, so this is
really just a suggestion.
--
You are receiving this mail because:
You are watching all bug changes.
