Skip to content

Fix stale docs #427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tcharding merged 3 commits into from
Dec 9, 2025
Merged

Fix stale docs #427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5d20b6
Fix stale rustdoc version
jamillambert Dec 8, 2025
58ce9ef
Update rustdoc comment about no default features
jamillambert Dec 8, 2025
4f269d5
Update stale README.md section
jamillambert Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions bitreq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ require a higher MSRV.
## License
This crate is distributed under the terms of the [ISC license](COPYING.md).

## Planned for 3.0.0
## Planned for a future major release

This is a list of features I'll implement once it gets long enough, or
a severe enough issue is found that there's good reason to make a
Expand All @@ -59,9 +59,6 @@ major version bump.
with `http://` or `https://`.
- Change default proxy port to 1080 (from 8080). Curl uses 1080, so it's a sane
default.
- Bump MSRV enough to compile the latest versions of all dependencies, and add
the `rust-version` (at least 1.56) and `edition` (at least 2021) fields to
Cargo.toml.

### Potential ideas

Expand Down
8 changes: 4 additions & 4 deletions bitreq/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
//! # Additional features
//!
//! Since the crate is supposed to be minimal in terms of
//! dependencies, there are no default features, and optional
//! functionality can be enabled by specifying features for `bitreq`
//! dependency in `Cargo.toml`:
//! dependencies, only the `std` feature is enabled by default.
//! Additional functionality can be enabled by specifying features for
//! the `bitreq` dependency in `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! bitreq = { version = "2.13.5-alpha", features = ["https"] }
//! bitreq = { version = "0.2.0", features = ["https"] }
//! ```
//!
//! Below is the list of all available features.
Expand Down