Skip to content

[LS] Format docstring annotations#635

Open
turbolent wants to merge 2 commits into
masterfrom
bastian/format-docstring-annotations
Open

[LS] Format docstring annotations#635
turbolent wants to merge 2 commits into
masterfrom
bastian/format-docstring-annotations

Conversation

@turbolent

Copy link
Copy Markdown
Member

Description

Pre-process docstrings before displaying them in hover and completion results. Parse the annotations as supported in the documentation generation tool, converting @param name: desc and @return desc annotations into readable Markdown.

Parameters are rendered as a **Parameters** section with a bulleted list (- `name`: desc), return values as **Returns** desc, both placed at the end after any other content.

Docstrings are pre-processed in all three places where they are surfaced: hover, member completion resolution, and range completion resolution.

Reported by @holyfuchs in onflow/flow-credit-markets#10 (comment)


  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@turbolent turbolent self-assigned this Apr 24, 2026
@turbolent turbolent requested a review from SupunS as a code owner April 24, 2026 00:33
@turbolent turbolent added the Improvement Technical work without new features, refactoring, improving tests label Apr 24, 2026
@turbolent turbolent enabled auto-merge April 24, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement Technical work without new features, refactoring, improving tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant