Broken link to Error struct in docs

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

Research direction

Start with the Reader documentation at the docs.rs URL in the issue and inspect the referenced Error link. Done means the link points to the existing struct.Error documentation rather than enum.Error and resolves successfully.

Written by the indexing model from the issue text.

Description

Thank you for taking the time to file a bug report. The following describes
some guidelines to creating a minimally useful ticket.

Above all else: do not describe your problem, SHOW your problem.

What version of the csv crate are you using?

https://docs.rs/csv/latest/csv/struct.Reader.html

Briefly describe the question, bug or feature request.

At docs.rs, there is a broken link on the Reader page (url above) in the text "For more details on the precise semantics of errors, see the Error type."

Maybe the Error type was changed from an Enum to a Struct at some point. And the docs need to be updated.
So https://docs.rs/csv/latest/csv/enum.Error.html should be https://docs.rs/csv/latest/csv/struct.Error.html instead.

Thanks

Dominant language
Rust
Stars
2k
Forks
256
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 BurntSushi/rust-csv

All issues in BurntSushi/rust-csv

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.