For example: Mnemonic::generate, Mnemonic::generate_in and Mnemonic::generate_in_with are completely omitted from the API documentation, and there is no mention of the features that enable them:
From the API documentation alone, one would have no idea that this functionality exists or how to use it.
Instead, these feature gated items should appear in the API documentation along with a marker that identifies them as being available only with certain crate features enabled. Here is an example of how it should look taken from the k256 crate:
.
For example:
Mnemonic::generate,Mnemonic::generate_inandMnemonic::generate_in_withare completely omitted from the API documentation, and there is no mention of the features that enable them:From the API documentation alone, one would have no idea that this functionality exists or how to use it.
Instead, these feature gated items should appear in the API documentation along with a marker that identifies them as being available only with certain crate features enabled. Here is an example of how it should look taken from the
.
k256crate: