Bug: microsoft document and crates.io out of date

[ghost]

Which crate is this about?

other (please share in the comments)

Crate version

No response

Summary

i can't find Transform BOOL and Win32 return values #2476 in microsoft document

Toolchain version/configuration

No response

Reproducible example

No response

Crate manifest

No response

Expected behavior

No response

Actual behavior

No response

Additional comments

No response

[tim-weis]

The latest version of the windows crate (0.48.0) was released on March 31st, 2023. PR #2476 was merged on April 26th, 2023.

In other words: The BOOL/last error code -> Result<()> transformation hasn't been published yet, and the documentation properly reflects the latest published version of the windows crate.

[tim-weis]

It's not clear from the issue what the goal is.

If you just want to take advantage of the convenience introduced by PR #2476, you can specify a git repository dependency in your Cargo.toml, something like this:

[dependencies.windows]
git = "https://github.com/microsoft/windows-rs.git"
rev = "refs/pull/2476/head"
features = []

The rev table entry isn't strictly required. It locks the dependency on the specific PR that introduced this feature. It can be omitted if that is not something you need.

That works¹, as long as you aren't planning to publish a crate with this dependency through crates.io. If you are, you'll need to request a new release, which would also update the documentation to align with the published artifacts.

Footnotes

1. If you are fine writing code against an interface that doesn't match the published documentation. ↩