gimli-rs / object

A unified interface for reading and writing object file formats
https://docs.rs/object/
Apache License 2.0
673 stars 156 forks source link

Documentation is missing feature flags #688

Open tbu- opened 6 months ago

tbu- commented 6 months ago

In the documentation, you can't see which feature flags need to be activated for a certain function/struct/module to be available.

E.g. like you can see in zerocopy's docs that the byteorder feature is required for the byteorder module to be available.

philipc commented 6 months ago

Is there a particular item that you thought this would be helpful for? Most of the features have a simple mapping to module names.

doc_cfg and doc_auto_cfg are unstable features. doc_cfg requires manual annotation; I could add this for the top level modules if that is sufficient. doc_auto_cfg gives output like the following which is too much noise:

image

or the following which isn't giving any non-obvious information:

image