Incorrect documentation of the `split` method

Open Beginner friendly
#85 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
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

Open src/lib.rs around lines 532-533 and read the documentation for the split method. Correct the stated return-value order or remove the misleading “in that order” wording, then verify that the documentation matches the method's actual (first, [middle], last) result.

Written by the indexing model from the issue text.

Description

The documentation of the split method suggest a return value of (first, last, [middle]), while it's actually (first, [middle], last).

https://github.com/cloudhead/nonempty/blob/95d5cb131262b12bbe55366cbbd48096f9a05493/src/lib.rs#L532-L533

It can be fixed by either simply removing the "in that order" part, or by changing the listing to "first, middle and last elements".

I'd be happy creating a PR for fixing that, if you'd like.

Dominant language
Rust
Stars
74
Forks
30
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 cloudhead/nonempty

All issues in cloudhead/nonempty

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.