search

kinnison / marked-data

A YAML representation library which explicitly retains provenance data
MIT License
13 stars 6 forks source link

Better document feature flags #18

Open not-my-profile opened 1 month ago

not-my-profile commented 1 month ago

I started using this crate with only the serde feature. I didn't enable the serde-path feature because I don't need need any paths. I then noticed that for syntax errors the markers were None ... I thought that this was a bug until I eventually figured out that this gets fixed when you enable the serde-path feature.

Looking further into this, this indeed is documented in the top-level README of the repository ... which I hadn't read, I was only looking at the crates.io README and the rustdoc. We should move this note from the top-level README into the crate README/rustdoc.

kinnison commented 1 month ago

I'd be happy to take a PR for this.