From c4050b41a2fcb970d9eb536823baa8fba27bea07 Mon Sep 17 00:00:00 2001
From: Ed Page <epage@duosecurity.com>
Date: Thu, 13 May 2021 13:34:21 -0500
Subject: [PATCH] fix(cli): Clarify API stabiliy

For now, I'm just punting on `typos_cli`s API.

Fixes #171
---
 src/file.rs | 4 ++--
 src/lib.rs  | 8 ++++++++
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/file.rs b/src/file.rs
index 6796de8..97c8db5 100644
--- a/src/file.rs
+++ b/src/file.rs
@@ -380,7 +380,7 @@ impl FileChecker for FoundFiles {
     }
 }
 
-pub fn read_file(
+fn read_file(
     path: &std::path::Path,
     reporter: &dyn report::Report,
 ) -> Result<(Vec<u8>, content_inspector::ContentType), std::io::Error> {
@@ -418,7 +418,7 @@ pub fn read_file(
     Ok((buffer, content_type))
 }
 
-pub fn write_file(
+fn write_file(
     path: &std::path::Path,
     content_type: content_inspector::ContentType,
     buffer: Vec<u8>,
diff --git a/src/lib.rs b/src/lib.rs
index ab43959..3a7b687 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,13 @@
+/// `typos_cli`'s API is unstable.  Open an issue for starting a discussion on getting a subset
+/// stabilized.
+
+#[doc(hidden)]
 pub mod config;
+#[doc(hidden)]
 pub mod dict;
+#[doc(hidden)]
 pub mod file;
+#[doc(hidden)]
 pub mod policy;
+#[doc(hidden)]
 pub mod report;