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

docs: improve HtmlRspackPlugin docs and types #9144

Merged

Conversation

grushetsky
Copy link
Contributor

Summary

Changes:

  • Fixes the description of HtmlRspackPluginOptions.meta and HtmlRspackPluginOptions.hash fields (previously these were mixed up in places).
  • Improve descriptions and default values of other fields from HtmlRspackPluginOptions.
  • Align the docs on HtmlRspackPluginOptions with the updated type.
  • Apply other minor formatting and wording updates to HtmlRspackPlugin documentation.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

netlify bot commented Feb 1, 2025

Deploy Preview for rspack ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2070d01
🔍 Latest deploy log https://app.netlify.com/sites/rspack/deploys/679e13eb867d9b0008f9d5f8
😎 Deploy Preview https://deploy-preview-9144--rspack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@grushetsky grushetsky changed the title Improve HtmlRspackPlugin Docs and Types docs: improve HtmlRspackPlugin docs and types Feb 1, 2025
@github-actions github-actions bot added the release: document release: document related release(mr only) label Feb 1, 2025
Copy link
Member

@chenjiahan chenjiahan left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you for your detailed improvement of the documentation. ❤️

@chenjiahan chenjiahan enabled auto-merge (squash) February 2, 2025 02:10
Copy link

codspeed-hq bot commented Feb 2, 2025

CodSpeed Performance Report

Merging #9144 will not alter performance

Comparing grushetsky:fix-html-rspack-plugin-description (2070d01) with main (effe83c)

Summary

✅ 6 untouched benchmarks

@chenjiahan chenjiahan merged commit 98d1c37 into web-infra-dev:main Feb 2, 2025
34 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release: document release: document related release(mr only)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants