actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 09:01:04 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #246 from epage/api

Browse source 
fix(cli): Clarify API stabiliy
This commit is contained in:
Ed Page 2021-05-13 16:39:02 -05:00 committed by GitHub
commit cc5c2b6f5d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/file.rs
View file

@ -380,7 +380,7 @@ impl FileChecker for FoundFiles {
} }
} }
pub fn read_file( fn read_file(
path: &std::path::Path, path: &std::path::Path,
reporter: &dyn report::Report, reporter: &dyn report::Report,
) -> Result<(Vec<u8>, content_inspector::ContentType), std::io::Error> { ) -> Result<(Vec<u8>, content_inspector::ContentType), std::io::Error> {
@ -418,7 +418,7 @@ pub fn read_file(
Ok((buffer, content_type)) Ok((buffer, content_type))
} }
pub fn write_file( fn write_file(
path: &std::path::Path, path: &std::path::Path,
content_type: content_inspector::ContentType, content_type: content_inspector::ContentType,
buffer: Vec<u8>, buffer: Vec<u8>,

8
src/lib.rs
View file

@ -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; pub mod config;
#[doc(hidden)]
pub mod dict; pub mod dict;
#[doc(hidden)]
pub mod file; pub mod file;
#[doc(hidden)]
pub mod policy; pub mod policy;
#[doc(hidden)]
pub mod report; pub mod report;