killercup / killercup/a-range

Add docs with non-integer index types

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
good first issue Hacktoberfest help wanted
Dominant language
Rust
Stars
15
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Either the crate-level or the Range docs should describe how to write a custom type that can be used as an index. (This will require you to impl `num_traits::One` for the custom type, for example.)

Contributor guide

Open the contributing guide

Research direction

Review the crate-level documentation and the Range documentation to find the best place for an indexing example. Check how custom index types are constrained, including the need to implement num_traits::One, and document a complete example; the issue is done when users can understand how to use a non-integer index type.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.