Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
zth merged 5 commits intorescript-lang:masterfrommediremi:module-hover-divider
Aug 18, 2025

Conversation

@mediremi
Copy link
Member

@mediremimediremi commentedAug 17, 2025
edited
Loading

I've made hover information for modules more consistent with type hover information by adding aMarkdown.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:

/** My module with a doc comment. ## Examples ```rescript Foo.bar() Foo.baz() \```*/moduletypeFoo= {letbar:unit=>unitletbaz:unit=>unit}
BeforeAfter
imageimage

@mediremimediremi marked this pull request as ready for reviewAugust 17, 2025 15:36
@pkg-pr-new
Copy link

pkg-pr-newbot commentedAug 17, 2025
edited
Loading

Open in StackBlitz

rescript

npm i https://pkg.pr.new/rescript-lang/rescript@7775

@rescript/darwin-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-arm64@7775

@rescript/darwin-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/darwin-x64@7775

@rescript/linux-arm64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-arm64@7775

@rescript/linux-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/linux-x64@7775

@rescript/win32-x64

npm i https://pkg.pr.new/rescript-lang/rescript/@rescript/win32-x64@7775

commit:9ba2bb6

@nojaf
Copy link
Member

Too bad this doesn't come with some padding.

@zth
Copy link
Member

zth commentedAug 18, 2025

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.

@mediremi
Copy link
MemberAuthor

I've added some spacing withMarkdown.spacing 👍

@zthzth requested review fromCopilot,tsnobip andzth and removed request fortsnobipAugust 18, 2025 09:54
Copy link
Contributor

CopilotAI left a 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.

  • AddsMarkdown.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.

FileDescription
analysis/src/Hover.mlAdds markdown divider and spacing after module docstrings
tests/analysis_tests/tests/src/expected/Hover.res.txtUpdates test expectations to include new divider formatting
CHANGELOG.mdDocuments the new feature addition

Tip: Customize your code reviews with copilot-instructions.md.Create the file orlearn how to get started.

@zthzthenabled auto-merge (squash)August 18, 2025 09:54
@zthzth merged commit271a112 intorescript-lang:masterAug 18, 2025
27 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

Copilot code reviewCopilotCopilot left review comments

@zthzthzth approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mediremi@nojaf@zth

[8]ページ先頭

©2009-2025 Movatter.jp