8000 Add necessity of feature flag serde to api documentation for saveload · Issue #760 · amethyst/specs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Add necessity of feature flag serde to api documentation for saveload #760
Open
@andreas-wolf

Description

@andreas-wolf

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

  • Is it a breaking change? No
  • Can it impact performance, learnability, etc? Yes

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0