From f55070361f0fba70f3ad55d50d974f5516906695 Mon Sep 17 00:00:00 2001
From: Jeron Aldaron Lau <aldaronlau@gmail.com>
Date: Sat, 9 Mar 2024 18:36:20 -0600
Subject: [PATCH] Test docs in CI (#107)

---
 .github/workflows/ci.yml | 1 +
 src/lib.rs               | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index aa38ad9..a1dbb32 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -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
diff --git a/src/lib.rs b/src/lib.rs
index c755bcf..6bd0bb8 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -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`]):
 //!
@@ -46,6 +46,8 @@
 //!     whoami::arch(),
 //! );
 //! ```
+//!
+//! [`OsString`]: std::ffi::OsString
 
 #![warn(
     anonymous_parameters,