-
Notifications
You must be signed in to change notification settings - Fork 221
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
Add necessity of feature flag serde to api documentation for saveload #760
Comments
Hi @andreas-wolf can you prepare a PR that mabee adds a little block here: Unluckily ouir api also doesnt mention it on the structs itself, as the check is on the module: https://github.com/amethyst/specs/blob/master/src/lib.rs#L202 though tbh it kind of mentions it directly in the api doc that its going to use specs |
We might be able to use this https://doc.rust-lang.org/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg Also see here for examples of how to only enable the necessary nightly feature when docs.rs is building the docs: https://stackoverflow.com/a/61417700 |
Description
The saveload documentation states:
saveload is a module that provides mechanisms to serialize and deserialize a World, it makes use of the popular [serde](https://docs.rs/serde) library and requires the feature flag serde to be enabled for specs in your Cargo.toml file.
The API documentation does not mention this fact, but it was at least for me the first google search hit when I got
unresolved import specs::saveload
.Maybe it would even be worth it to add the information to the Troubleshooting section
Motivation
I had to search quite a long time to find that information. I assume I'm not the only person to search the API than to read the tutorial.
Drawbacks
None
The text was updated successfully, but these errors were encountered: