Skip to content

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Sep 18, 2025

Follow-on after #13867.

Correct the assembly examples. AI copied its invented assembly from #13788. Replace it with the actual assembly!

Also move the # SAFETY comment higher up, as that's more important than the perf analysis.

@github-actions github-actions bot added the A-parser Area - Parser label Sep 18, 2025
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Sep 18, 2025
@overlookmotel overlookmotel marked this pull request as ready for review September 18, 2025 08:00
Copilot AI review requested due to automatic review settings September 18, 2025 08:00
@overlookmotel overlookmotel self-assigned this Sep 18, 2025
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Sep 18, 2025
Copy link
Contributor

Copilot AI 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 documentation for the Token::read_bool method by correcting inaccurate assembly examples and reorganizing the content for better clarity.

Key changes:

  • Replace AI-generated assembly examples with actual assembly code from compiler output
  • Move the safety documentation above performance analysis for better prioritization
  • Add a link to Godbolt for verification of assembly examples

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

Copy link
Member Author

overlookmotel commented Sep 18, 2025

Merge activity

@codspeed-hq
Copy link

codspeed-hq bot commented Sep 18, 2025

CodSpeed Instrumentation Performance Report

Merging #13873 will not alter performance

Comparing 09-18-docs_parser_improve_docs_for_token_read_bool_ (3a03b85) with main (57108c0)1

Summary

✅ 37 untouched

Footnotes

  1. No successful run was found on main (8221a01) during the generation of this report, so 57108c0 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Follow-on after #13867.

Correct the assembly examples. AI copied its invented assembly from #13788. Replace it with the *actual* assembly!

Also move the `# SAFETY` comment higher up, as that's more important than the perf analysis.
@graphite-app graphite-app bot force-pushed the 09-18-docs_parser_improve_docs_for_token_read_bool_ branch from 8129bd1 to 3a03b85 Compare September 18, 2025 08:08
@graphite-app graphite-app bot merged commit 3a03b85 into main Sep 18, 2025
27 checks passed
@graphite-app graphite-app bot deleted the 09-18-docs_parser_improve_docs_for_token_read_bool_ branch September 18, 2025 08:14
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-parser Area - Parser C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants