From 06909f182151cf2332a14909e8b772ab4648854e Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Mon, 5 Sep 2022 01:30:58 +0300 Subject: fix(tvix/eval): fix doc comment syntax where applicable As pointed out by grfn on cl/6091 Change-Id: I28308577b7cf99dffb4a4fd3cc8783eb9ab4d0d6 Reviewed-on: https://cl.tvl.fyi/c/depot/+/6460 Tested-by: BuildkiteCI Reviewed-by: sterni --- tvix/eval/src/value/string.rs | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'tvix/eval/src/value/string.rs') diff --git a/tvix/eval/src/value/string.rs b/tvix/eval/src/value/string.rs index 095f87645cc5..aa542181f9b1 100644 --- a/tvix/eval/src/value/string.rs +++ b/tvix/eval/src/value/string.rs @@ -72,12 +72,12 @@ impl NixString { } } - // Return a displayable representation of the string as an - // identifier. - // - // This is used when printing out strings used as e.g. attribute - // set keys, as those are only escaped in the presence of special - // characters. + /// Return a displayable representation of the string as an + /// identifier. + /// + /// This is used when printing out strings used as e.g. attribute + /// set keys, as those are only escaped in the presence of special + /// characters. pub fn ident_str(&self) -> Cow { let escaped = nix_escape_string(self.as_str()); @@ -111,10 +111,10 @@ fn nix_escape_char(ch: char, next: Option<&char>) -> Option<&'static str> { } } -// Escape a Nix string for display, as most user-visible representation -// are escaped strings. -// -// Note that this does not add the outer pair of surrounding quotes. +/// Escape a Nix string for display, as most user-visible representation +/// are escaped strings. +/// +/// Note that this does not add the outer pair of surrounding quotes. fn nix_escape_string(input: &str) -> Cow { let mut iter = input.chars().enumerate().peekable(); -- cgit 1.4.1