Skip to content

Fix various Rust documentation formatting issues #23650

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

Open
wants to merge 1 commit into
base: production
Choose a base branch
from

Conversation

samscott89
Copy link

Summary

Related issue: #23649.

Found the Rust code samples that were formatting incorrectly and fixed them. Also tried to fix the spacing around
some of the code blocks with Tab components because in my experience that's where prettier can sometimes get confused.

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link
Contributor

hyperlint-ai bot commented Jul 14, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Fixed various formatting issues in Rust documentation across multiple examples.

  • Corrected formatting of Rust code samples for consistency.
  • Adjusted spacing around code blocks to improve readability.
  • Ensured adherence to the documentation style guide.

Modified Files

  • src/content/docs/workers/examples/basic-auth.mdx
  • src/content/docs/workers/examples/cors-header-proxy.mdx
  • src/content/docs/workers/examples/logging-headers.mdx
  • src/content/docs/workers/examples/security-headers.mdx
  • src/content/docs/workers/examples/websockets.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@@ -260,21 +260,22 @@ export default {
```

</TabItem> <TabItem label="Rust" icon="seti:rust">

Copy link
Author

Choose a reason for hiding this comment

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

FYI this blank space is what prevents (I think) prettier from treating the code block as markdown code which is what leads to it mangling the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:workers Related to Workers product size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants