Missing documentation for Request mode field

Open Beginner friendly
#55 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Open src/ehttp/types.rs around line 146 and compare the Request documentation shown on docs.rs for the wasm32 target. Add documentation for the mode: Mode field so users developing for wasm can understand it. Done means the field is clearly documented in the generated API documentation.

Written by the indexing model from the issue text.

Description

I want to highlight that struct Request has field mode: Mode: https://docs.rs/ehttp/0.5.0/src/ehttp/types.rs.html#146 that is not documented in docs.rs, since it has #[cfg(target_arch = "wasm32")].
This can create confusion when developing for wasm.

Thank for your great work

Dominant language
Rust
Stars
396
Forks
36
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 emilk/ehttp

All issues in emilk/ehttp

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.