hyperium / hyperium/hyperium.github.io

Shouldn't use of `extern` in documentation be removed?

Open
#57 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
34
Forks
71
Avg merge
1h 9m
Merged PRs (30d)
8

Description

The getting started guide of hyber uses extern crate hyper https://hyper.rs/guides/client/basic/

I was the opinion that extern is no longer necessary and the new/current module system does not require.

and indeed, I confirmed this by removing the extern and the code snippet in the example still works...

Question now is, shouldn't extern be removed from the documentation?

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.

Research direction

Start with the getting started guide at https://hyper.rs/guides/client/basic/ and inspect the example containing extern crate hyper. Verify that the snippet still works without that declaration, then update the documentation if confirmed; done means the guide reflects the current Rust module requirements.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.