serde_qs icon indicating copy to clipboard operation
serde_qs copied to clipboard

Shall README provide example of a "query string" or link to some RFC that describes them?

Open vi opened this issue 1 year ago • 2 comments

The "URL" in "serde_urlencoded" in the README suggests it is related to the web/browsers/HTTP world, but it is not obvious from README or repository description. I think README should provide more info about the format being parsed.

Compare with README of the linked library - it contains a link to a specification-esque document (but no example though) and a specific content type.

vi avatar Apr 23 '24 22:04 vi

Hey @vi. It's a very reasonable request.

I think the crate documentation does a better job at describing the purpose: https://docs.rs/serde_qs/latest/serde_qs/

What do you think? Are there parts of that you think I should reuse for the README?

samscott89 avatar Apr 26 '24 20:04 samscott89

Yes, that code example looks on the point. Something like this, but shorter and simpler (i.e. without nesting, only with e.g. two parameters), unless those square brackets and nesting is a distinctive advantage of the crate.

A link to RFC formally describing query strings would also be welcome (in crate documentation too).

vi avatar Apr 26 '24 21:04 vi