Incorrect docs: DefaultConfig

Open Beginner friendly
#323 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start in rmp-serde/src/config.rs at lines 58 and 87-97. Compare the DefaultConfig documentation with the implementation, update the description to explain how enum variants are represented, and verify that the documentation matches the code.

Written by the indexing model from the issue text.

Description

https://github.com/3Hren/msgpack-rust/blob/941441f484c325464c9746fdca9d11c1ca6a2d78/rmp-serde/src/config.rs#L58

It seems it doesn't actually write enum variants by index, it uses idents as strings to prefix enum variant.

Impl: https://github.com/3Hren/msgpack-rust/blob/941441f484c325464c9746fdca9d11c1ca6a2d78/rmp-serde/src/config.rs#L87-L97

Dominant language
Rust
Stars
1.4k
Forks
162
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from 3Hren/msgpack-rust

All issues in 3Hren/msgpack-rust

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.