Skip to content

Standardize doc comments printing #7529

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

shulhi
Copy link
Member

@shulhi shulhi commented May 27, 2025

No description provided.

Comment on lines 2 to 13
/** non-negative integer constant */
| Numeral(float)
/** Addition [e1 + e2] */
| Plus(expression, expression)
/** Difference [e1 - e2] */
| Minus(expression, expression)
/** Product [e1 * e2] */
| Times(expression, expression)
/** Quotient [e1 / e2] */
| Divide(expression, expression)
/** Opposite value [-e] */
| Negate(expression)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO this looks better

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately this syntax is invalid.

Copy link
Member Author

@shulhi shulhi May 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reported in #7534

@shulhi shulhi requested a review from cknitt May 29, 2025 01:43
@shulhi shulhi marked this pull request as ready for review May 29, 2025 01:44
@shulhi shulhi force-pushed the fix/standardize-doc-comments-attribute-printing branch from d8a634f to 606aa64 Compare May 29, 2025 01:45
@shulhi shulhi removed the request for review from cknitt May 29, 2025 01:53
@shulhi shulhi marked this pull request as draft May 29, 2025 01:53
Copy link

pkg-pr-new bot commented May 31, 2025

Open in StackBlitz

rescript

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

@rescript/darwin-arm64

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

@rescript/darwin-x64

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

@rescript/linux-arm64

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

@rescript/linux-x64

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

@rescript/win32-x64

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

commit: d73ec7e

@shulhi shulhi requested a review from cknitt May 31, 2025 06:26
@shulhi shulhi marked this pull request as ready for review May 31, 2025 06:26
Copy link
Member

@cknitt cknitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! This makes doc comments formatting so much better!

@shulhi shulhi merged commit af1eaa8 into rescript-lang:master Jun 2, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants