mirror of
https://github.com/crate-ci/typos.git
synced 2024-12-22 23:52:12 -05:00
fix(cli): Clarify API stabiliy
For now, I'm just punting on `typos_cli`s API. Fixes #171
This commit is contained in:
parent
21d02bd958
commit
c4050b41a2
2 changed files with 10 additions and 2 deletions
|
@ -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>,
|
||||
|
|
|
@ -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;
|
||||
|
|
Loading…
Reference in a new issue