Skip to content
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

Improved doc comment formatting #4135

Merged
merged 3 commits into from
Oct 7, 2024

Conversation

RunDevelopment
Copy link
Contributor

Changes:

  • The stars have aligned. The standard way to format /**-style doc comments is to align the starting * of subsequent lines with the first * in /**. This is now the case everywhere.
  • Do not emit empty doc comments.
  • Properly indent doc comments in .d.ts files.

This PR only changes code for comment generation and indentation.

Motivation: I just did it because (as a user of wasm-bindgen) the generated doc comments irked me and because (as a first-time contributor) it seemed like an easy fix.

@RunDevelopment
Copy link
Contributor Author

Uhm, why are elements generated in a different order in CI? I used BLESS=1 to get the reference files, so I don't understand why the CI gets a different result.

@daxpedda daxpedda merged commit 98c5e0b into rustwasm:main Oct 7, 2024
40 of 41 checks passed
@RunDevelopment RunDevelopment deleted the doc-comment-formatting branch October 11, 2024 19:49
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