-
Notifications
You must be signed in to change notification settings - Fork 471
Add markdown divider between module doc and module type in hover information #7775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
rescript
@rescript/darwin-arm64
@rescript/darwin-x64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/win32-x64
commit: |
Too bad this doesn't come with some padding. |
IIRC I faked some padding with empty markdown (or was it code?) blocks. Maybe worth trying? Might still be some code in there for that. |
3099d6d
to
9ba2bb6
Compare
I've added some spacing with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR improves the visual separation in module hover information by adding a markdown divider between a module's documentation and its type definition, making it consistent with how type hover information is displayed.
- Adds
Markdown.divider
andMarkdown.spacing
between module docstrings and module type definitions - Updates test expectations to reflect the new formatting with dividers
- Improves readability by clearly separating documentation from type information
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
analysis/src/Hover.ml | Adds markdown divider and spacing after module docstrings |
tests/analysis_tests/tests/src/expected/Hover.res.txt | Updates test expectations to include new divider formatting |
CHANGELOG.md | Documents the new feature addition |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
I've made hover information for modules more consistent with type hover information by adding a
Markdown.divider
between a module's doc string and its contents.Thanks to the divider, it's easier to tell where a doctring ends and where the module type definition starts: