SoftbearStudios / SoftbearStudios/bitcode
Have docs.rs create docs for all features
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 671
- Forks
- 61
- PR merge metrics
- No merged PRs in 30d
Description
Cargo.toml should have set
[package.metadata.docs.rs]
all-features = true
instead of just
features = [ "derive", "serde", "std" ]
This way a single search is enough to check whether bitcode itself supports a format and what feature flag is necessary to enable said format.
It took me quite a lot of time to realize, that bitcode does in fact support time.
I did not check the Cargo.toml, but rather expected the docs on docs.rs to be complete.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in Cargo.toml and compare the existing docs.rs package metadata with the requested all-features setting. Update the docs.rs configuration so documentation covers every feature, then verify that the published documentation exposes formats such as time and their required feature flags.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100