Skip to content

Commit

Permalink
Backport v2 -> v1: Test docs in CI (#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
AldaronLau authored Mar 10, 2024
1 parent 4bbaf52 commit 7789b3f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ jobs:
profile: minimal
toolchain: ${{ matrix.tc }}
override: true
- run: cargo doc
- run: cargo test --all --all-features
test-macos:
runs-on: macos-latest
Expand Down
4 changes: 3 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//! Using the whoami crate is super easy! All of the public items are simple
//! functions with no parameters that return [`String`]s or [`OsString`]s (with
//! the exception of [`desktop_env()`], [`platform()`], and [`arch()`], which
//! return enums, and [`lang()`] that returns an iterator of [`String`]s). The
//! return enums, and [`langs()`] that returns an iterator of [`String`]s). The
//! following example shows how to use all of the functions (except those that
//! return [`OsString`]):
//!
Expand Down Expand Up @@ -46,6 +46,8 @@
//! whoami::arch(),
//! );
//! ```
//!
//! [`OsString`]: std::ffi::OsString
#![warn(
anonymous_parameters,
Expand Down

0 comments on commit 7789b3f

Please sign in to comment.