Skip to content
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.

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

fix(cli): Clarify API stabiliy #246

Merged
merged 1 commit into from
May 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions src/file.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down Expand Up @@ -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>,
Expand Down
8 changes: 8 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -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;