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

[Feature]: Improve crate top-level documentation #83

Open
1 task done
nakedible-p opened this issue May 10, 2023 · 0 comments
Open
1 task done

[Feature]: Improve crate top-level documentation #83

nakedible-p opened this issue May 10, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@nakedible-p
Copy link

Is there an existing issue for this?

  • I have searched the existing issues

Description

Both serde_json and serde_cbor have very nice top-level documentation for their crate, showing all the common usage modes. In comparison, ciborium says at the top level:

You’re probably looking for from_reader() and into_writer(), which are the main functions. Note that byte slices are also readers and writers and can be passed to these functions just as streams can.

For dynamic CBOR value creation/inspection, see Value.

And then peeking into from_reader shows just:

Deserializes as CBOR from a type with impl ciborium_io::Read

There are no examples on what all that trait is implemented on, or in general common ways to use the library.

I believe a similar top-level documentation to serde_json and serde_cbor should also be written for ciborium and I believe it could boost the usage of the crate.

Acceptance Criteria

No response

Suggestions for a technical implementation

I may be able to provide a pull for this, if I get encouragement to do so.

@nakedible-p nakedible-p added the enhancement New feature or request label May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: New
Development

No branches or pull requests

1 participant