diff options
author | Vincent Ambo <mail@tazj.in> | 2022-08-14T00·08+0300 |
---|---|---|
committer | tazjin <tazjin@tvl.su> | 2022-08-30T17·13+0000 |
commit | 8d45fbadeac9c90e216c872326919cf012fa24f6 (patch) | |
tree | b9d71f5dc5e5f06c95ded4e2daebaa119aa7548f /tvix/eval | |
parent | 11ea7b82d87f47027e7ff030ca797f71a13cc9ac (diff) |
docs(tvix/eval): Use correct syntax for module doc comments r/4540
Change-Id: I35741856f34b86a538f226a8eaf8806edede60ec Reviewed-on: https://cl.tvl.fyi/c/depot/+/6207 Reviewed-by: grfn <grfn@gws.fyi> Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/eval')
-rw-r--r-- | tvix/eval/src/value/attrs.rs | 14 | ||||
-rw-r--r-- | tvix/eval/src/value/list.rs | 2 | ||||
-rw-r--r-- | tvix/eval/src/value/string.rs | 5 | ||||
-rw-r--r-- | tvix/eval/src/warnings.rs | 4 |
4 files changed, 12 insertions, 13 deletions
diff --git a/tvix/eval/src/value/attrs.rs b/tvix/eval/src/value/attrs.rs index 86d963bd3a00..ca92636046ba 100644 --- a/tvix/eval/src/value/attrs.rs +++ b/tvix/eval/src/value/attrs.rs @@ -1,10 +1,10 @@ -/// This module implements Nix attribute sets. They have flexible -/// backing implementations, as they are used in very versatile -/// use-cases that are all exposed the same way in the language -/// surface. -/// -/// Due to this, construction and management of attribute sets has -/// some peculiarities that are encapsulated within this module. +//! This module implements Nix attribute sets. They have flexible +//! backing implementations, as they are used in very versatile +//! use-cases that are all exposed the same way in the language +//! surface. +//! +//! Due to this, construction and management of attribute sets has +//! some peculiarities that are encapsulated within this module. use std::collections::btree_map; use std::collections::BTreeMap; use std::fmt::Display; diff --git a/tvix/eval/src/value/list.rs b/tvix/eval/src/value/list.rs index fab85a73ec2f..31f223fce599 100644 --- a/tvix/eval/src/value/list.rs +++ b/tvix/eval/src/value/list.rs @@ -1,4 +1,4 @@ -/// This module implements Nix lists. +//! This module implements Nix lists. use std::fmt::Display; use super::Value; diff --git a/tvix/eval/src/value/string.rs b/tvix/eval/src/value/string.rs index 122a82e04802..42d9366b958f 100644 --- a/tvix/eval/src/value/string.rs +++ b/tvix/eval/src/value/string.rs @@ -1,10 +1,9 @@ +//! This module implements Nix language strings and their different +//! backing implementations. use smol_str::SmolStr; use std::hash::Hash; use std::{borrow::Cow, fmt::Display}; -/// This module implements Nix language strings and their different -/// backing implementations. - #[derive(Clone, Debug)] enum StringRepr { Smol(SmolStr), diff --git a/tvix/eval/src/warnings.rs b/tvix/eval/src/warnings.rs index 953f93ff467e..558a833662e9 100644 --- a/tvix/eval/src/warnings.rs +++ b/tvix/eval/src/warnings.rs @@ -1,5 +1,5 @@ -/// Warnings are emitted in cases where code passed to Tvix exhibits -/// problems that the user could address. +//! Implements warnings that are emitted in cases where code passed to +//! Tvix exhibits problems that the user could address. #[derive(Debug)] pub enum WarningKind { |