Skip to content

Rendered view for DocStrings and Comments in editor #153984

Open
@suspectinside

Description

Sources with a lot of documentation in it, it is real paradise but there is one HUGE trouble - all that mess is completely unreadable.

VSCode has a nice feature - 'Popup hints' which shows DocStrings(for example) already auto-formated and with syntax highlighting:

Rendered_Docstrings.mp4

...but all that code-mess is still there, occupies a lot of space but still is completely unreadable!

But why not to show something like this:

rendered

So i'd like to propose this new feature (well... in JetBrains' it already for a year approximatly) - Rendered Comments.

and to specify some Main Peacularities:

  1. Global Rendered Comments/DocStrings/etc mode toggling
  2. ability to toggle (with keyboard binding) Rendered Mode as for one concreate comment and for all other in the current editor
  3. collapse/expand rendered/raw docstring/comment with hotkeys in the current editor
  4. Block with Rendered Comments in editor should has the same coloring, highlighting as the existing PopUp (in regards with the current Theme)
  5. attempt to modify smth in the Comment Block should autoswitch it from Rendered to reggular (editable/text) mode

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

editor-contribEditor collection of extraseditor-coreEditor basic functionalityfeature-requestRequest for new features or functionality

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions