Skip to content
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

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

Open
vi opened this issue Apr 23, 2024 · 2 comments

Comments

@vi
Copy link

vi commented Apr 23, 2024

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.

@samscott89
Copy link
Owner

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?

@vi
Copy link
Author

vi commented Apr 26, 2024

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants