From 8d45fbadeac9c90e216c872326919cf012fa24f6 Mon Sep 17 00:00:00 2001
From: Vincent Ambo <mail@tazj.in>
Date: Sun, 14 Aug 2022 03:08:11 +0300
Subject: [PATCH] docs(tvix/eval): Use correct syntax for module doc comments

Change-Id: I35741856f34b86a538f226a8eaf8806edede60ec
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6207
Reviewed-by: grfn <grfn@gws.fyi>
Tested-by: BuildkiteCI
---
 tvix/eval/src/value/attrs.rs  | 14 +++++++-------
 tvix/eval/src/value/list.rs   |  2 +-
 tvix/eval/src/value/string.rs |  5 ++---
 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 86d963bd3..ca9263604 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 fab85a73e..31f223fce 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 122a82e04..42d9366b9 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 953f93ff4..558a83366 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 {