docs: improved monospace quoting and gramar fixes (#619)

cargo-insta/src/cli.rs

@@ -83,7 +83,7 @@ enum Command {
 
 #[derive(Args, Debug, Clone)]
 struct TargetArgs {
-    /// Path to Cargo.toml
+    /// Path to `Cargo.toml`
     #[arg(long, value_name = "PATH")]
     manifest_path: Option<PathBuf>,
     /// Explicit path to the workspace root
@@ -95,7 +95,7 @@ struct TargetArgs {
     /// Work on all packages in the workspace
     #[arg(long)]
     workspace: bool,
-    /// Alias for --workspace (deprecated)
+    /// Alias for `--workspace` (deprecated)
     #[arg(long)]
     all: bool,
     /// Also walk into ignored paths.

cargo-insta/src/utils.rs

@@ -48,7 +48,7 @@ lazy_static! {
     pub static ref INSTA_VERSION: Version = read_insta_version().unwrap();
 }
 
-/// cargo-insta version
+/// `cargo-insta` version
 // We could put this in a lazy_static
 pub(crate) fn cargo_insta_version() -> String {
     env!("CARGO_PKG_VERSION").to_string()

insta/src/content/yaml/vendored/emitter.rs

@@ -1,6 +1,5 @@
 use crate::content::yaml::vendored::yaml::{Hash, Yaml};
 
-use std::convert::From;
 use std::error::Error;
 use std::fmt::{self, Display};
 
@@ -250,19 +249,20 @@ impl<'a> YamlEmitter<'a> {
 }
 
 /// Check if the string requires quoting.
+///
 /// Strings starting with any of the following characters must be quoted.
-/// :, &, *, ?, |, -, <, >, =, !, %, @
+/// `:`, `&`, `*`, `?`, `|`, `-`, `<`, `>`, `=`, `!`, `%`, `@`
 /// Strings containing any of the following characters must be quoted.
-/// {, }, [, ], ,, #, `
+/// `{`, `}`, `[`, `]`, `,`, `#`, `\``
 ///
 /// If the string contains any of the following control characters, it must be escaped with double quotes:
-/// \0, \x01, \x02, \x03, \x04, \x05, \x06, \a, \b, \t, \n, \v, \f, \r, \x0e, \x0f, \x10, \x11, \x12, \x13, \x14, \x15, \x16, \x17, \x18, \x19, \x1a, \e, \x1c, \x1d, \x1e, \x1f, \N, \_, \L, \P
+/// `\0`, `\x01`, `\x02`, `\x03`, `\x04`, `\x05`, `\x06`, `\a`, `\b`, `\t`, `\n, `\v, `\f`, `\r`, `\x0e`, `\x0f`, `\x10`, `\x11`, `\x12`, `\x13`, `\x14`, `\x15`, `\x16`, `\x17`, `\x18`, `\x19`, `\x1a`, `\e`, `\x1c`, `\x1d`, `\x1e`, `\x1f`, `\N`, `\_`, `\L`, `\P`
 ///
 /// Finally, there are other cases when the strings must be quoted, no matter if you're using single or double quotes:
-/// * When the string is true or false (otherwise, it would be treated as a boolean value);
-/// * When the string is null or ~ (otherwise, it would be considered as a null value);
-/// * When the string looks like a number, such as integers (e.g. 2, 14, etc.), floats (e.g. 2.6, 14.9) and exponential numbers (e.g. 12e7, etc.) (otherwise, it would be treated as a numeric value);
-/// * When the string looks like a date (e.g. 2014-12-31) (otherwise it would be automatically converted into a Unix timestamp).
+/// * When the string is `true` or `false` (otherwise, it would be treated as a boolean value);
+/// * When the string is `null` or `~` (otherwise, it would be considered as a null value);
+/// * When the string looks like a number, such as integers (e.g. `2`, `14`, etc.), floats (e.g. `2.6`, `14.9`) and exponential numbers (e.g. `12e7`, etc.) (otherwise, it would be treated as a numeric value);
+/// * When the string looks like a date (e.g. `2014-12-31`) (otherwise it would be automatically converted into a Unix timestamp).
 fn need_quotes(string: &str) -> bool {
     fn need_quotes_spaces(string: &str) -> bool {
         string.starts_with(' ') || string.ends_with(' ')

insta/src/glob.rs

@@ -15,9 +15,9 @@ pub(crate) struct GlobCollector {
     pub(crate) show_insta_hint: bool,
 }
 
-// the glob stack holds failure count + an indication if cargo insta review
-// should be run.
 lazy_static::lazy_static! {
+    /// the glob stack holds failure count and an indication if `cargo insta review`
+    /// should be run.
     pub(crate) static ref GLOB_STACK: Mutex<Vec<GlobCollector>> = Mutex::default();
 }
 

insta/src/lib.rs

@@ -46,7 +46,8 @@
 //! ```
 //!
 //! The recommended flow is to run the tests once, have them fail and check
-//! if the result is okay.  By default the new snapshots are stored next
+//! if the result is okay.
+//! By default, the new snapshots are stored next
 //! to the old ones with the extra `.new` extension.  Once you are satisfied
 //! move the new files over.  To simplify this workflow you can use
 //! `cargo insta review` (requires
@@ -190,7 +191,7 @@
 //! # Dependencies
 //!
 //! `insta` tries to be light in dependencies but this is tricky to accomplish
-//! given what it tries to do.  By default it currently depends on `serde` for
+//! given what it tries to do.  By default, it currently depends on `serde` for
 //! the [`assert_toml_snapshot!`] and [`assert_yaml_snapshot!`] macros.  In the
 //! future this default dependencies will be removed.  To already benefit from
 //! this optimization you can disable the default features and manually opt into

insta/src/settings.rs

@@ -210,7 +210,7 @@ impl Settings {
 
     /// Disables prepending of modules to the snapshot filename.
     ///
-    /// By default the filename of a snapshot is `<module>__<name>.snap`.
+    /// By default, the filename of a snapshot is `<module>__<name>.snap`.
     /// Setting this flag to `false` changes the snapshot filename to just
     /// `<name>.snap`.
     ///
@@ -226,7 +226,7 @@ impl Settings {
 
     /// Allows the [`glob!`] macro to succeed if it matches no files.
     ///
-    /// By default the glob macro will fail the test if it does not find
+    /// By default, the glob macro will fail the test if it does not find
     /// any files to prevent accidental typos.  This can be disabled when
     /// fixtures should be conditional.
     ///