diesel-rs/diesel

First Rust example code on the website is unidiomatic

Open

#2451 opened on Jul 6, 2020

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Rust (12,054 stars) (1,003 forks)batch import
documentationhelp wanted

Description

The first Rust code example, also available under examples/postgres/getting_started_step_1, is using .ok(); to discard the error case of a Result. If ignoring any errors is intentional, that line should be updated from

dotenv().ok();

to

let _ = dotenv();

Otherwise, the .ok() should be replaced by something else (maybe .expect("dotenv setup to be successful")).

Checklist

  • I have already looked over the issue tracker for similar issues.
  • This issue can be reproduced on Rust's stable channel. (Your issue will be closed if this is not the case) N/A

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue is to update the first Rust example code in `examples/postgres/getting started step 1/src/lib.rs`. The current line `dotenv().ok();` should be changed to either `let = dotenv();` or `dotenv().expect("dotenv setup to be successful");`. The contributor should open a pull request making this change. No additional investigation is needed beyond reading the issue and the linked file.