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

native cfg alias is public but not documented #5986

Open
kpreid opened this issue Jul 18, 2024 · 0 comments
Open

native cfg alias is public but not documented #5986

kpreid opened this issue Jul 18, 2024 · 0 comments
Labels
area: documentation Documentation for crate items, public or private type: enhancement New feature or request

Comments

@kpreid
Copy link
Contributor

kpreid commented Jul 18, 2024

Description
The current (22.0.0) documentation for Instance::enumerate_adapters() says:

pub fn enumerate_adapters(&self, backends: Backends) -> Vec<Adapter>

Available on native only.

“native” is insufficient information to help dependent crate authors write code that compiles under all conditions. The crate documentation does mention “Feature Aliases” but doesn't explain what “native” means. Dependents need to be able to exactly match this cfg condition (or at least a subset of it) to avoid compilation failures.

(But surely the dependent crate either needs enumerate_adapters or not, you ask? Well, in this case, it's just debug logging of available adapters, so if the information is unavailable, that's fine.)

I haven't looked to see if any of the other cfg aliases that are undocumented appear publicly.

@teoxoy teoxoy added type: enhancement New feature or request area: documentation Documentation for crate items, public or private labels Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Documentation for crate items, public or private type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants