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

Correct float docs for wasmparser::BinaryReader #1777

Merged

Conversation

samestep
Copy link
Contributor

This PR corrects the docstrings for wasmparser::BinaryReader::read_f32 and wasmparser::BinaryReader::read_f64, which were previously identical to each other and both incorrect.

@samestep
Copy link
Contributor Author

I'm guessing this build error is unrelated?

error: missing documentation for a constant
  --> crates/wast/src/lexer.rs:65:1
   |
64 |   #[test]
   |   ------- in this procedural macro expansion
65 | / fn token_is_not_too_big() {
66 | |     assert!(std::mem::size_of::<Token>() <= std::mem::size_of::<u64>() * 2);
67 | | }
   | |_^
   |
note: the lint level is defined here
  --> crates/wast/src/lib.rs:53:9
   |
53 | #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
   |         ^^^^^^^^^^^^
   = note: this error originates in the attribute macro `test` (in Nightly builds, run with -Z macro-backtrace for more info)

error: could not compile `wast` (lib test) due to 1 previous error

@alexcrichton
Copy link
Member

Ah that looks like a nightly issue/regression, I'll work on getting that fixed, will let you know!

@alexcrichton
Copy link
Member

Ok mind rebasing on main now that #1778 has merged? That should fix the CI issues here

@samestep
Copy link
Contributor Author

@alexcrichton done! (And the same effect would have been achieved even if I had just pushed a dummy commit instead of actually merging/rebasing onto main, since the GitHub Actions pull_request event automatically creates a synthetic merge commit with the target branch before running CI.)

@alexcrichton alexcrichton added this pull request to the merge queue Sep 11, 2024
Merged via the queue into bytecodealliance:main with commit fdd04c7 Sep 11, 2024
30 checks passed
@samestep samestep deleted the wasmparser-read-float-docstrings branch September 11, 2024 18:05
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