Document feature flags

[johanhelsing]

What problem did the developer encounter?

I ran into #421, and it seems I can work around it by enabling the ui and block_ui_interactions cargo features, however without reading the source code, it's unclear to me what these flags do and if they affect my app in an undesired way (apart from adding a bevy_ui dep)

What was the fix?

How could this be better documented?

Maybe it would be possible to explain it here?

https://docs.rs/crate/leafwing-input-manager/0.11.2/features

[alice-i-cecile]

Oh super interesting. I don't know if / how we can generate docs that will show up there.

That said, we should definitely document these. Unless there's an answer to the above question, that belongs in the Cargo.toml where the flags are defined.

[Shute052]

Unfortunately, writing documentation on the features page of the docs.rs is unfeasible. Nowadays, even for well-documented crates, most can only include the documentation as part of the index page. For example, ndarray and time. This limitation stems from the Rust official docs.rs generator, which exclusively compiles feature flags alongside their respective sub-features‘ name. Please refer to its template for more details.

Update: Existing Rust RFC is here

[alice-i-cecile]

rust-lang/rust#96318 seems to be the upstream issue to follow.