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
This commit is contained in:
parent
11ea7b82d8
commit
8d45fbadea
4 changed files with 12 additions and 13 deletions
|
@ -1,10 +1,10 @@
|
||||||
/// This module implements Nix attribute sets. They have flexible
|
//! This module implements Nix attribute sets. They have flexible
|
||||||
/// backing implementations, as they are used in very versatile
|
//! backing implementations, as they are used in very versatile
|
||||||
/// use-cases that are all exposed the same way in the language
|
//! use-cases that are all exposed the same way in the language
|
||||||
/// surface.
|
//! surface.
|
||||||
///
|
//!
|
||||||
/// Due to this, construction and management of attribute sets has
|
//! Due to this, construction and management of attribute sets has
|
||||||
/// some peculiarities that are encapsulated within this module.
|
//! some peculiarities that are encapsulated within this module.
|
||||||
use std::collections::btree_map;
|
use std::collections::btree_map;
|
||||||
use std::collections::BTreeMap;
|
use std::collections::BTreeMap;
|
||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
/// This module implements Nix lists.
|
//! This module implements Nix lists.
|
||||||
use std::fmt::Display;
|
use std::fmt::Display;
|
||||||
|
|
||||||
use super::Value;
|
use super::Value;
|
||||||
|
|
|
@ -1,10 +1,9 @@
|
||||||
|
//! This module implements Nix language strings and their different
|
||||||
|
//! backing implementations.
|
||||||
use smol_str::SmolStr;
|
use smol_str::SmolStr;
|
||||||
use std::hash::Hash;
|
use std::hash::Hash;
|
||||||
use std::{borrow::Cow, fmt::Display};
|
use std::{borrow::Cow, fmt::Display};
|
||||||
|
|
||||||
/// This module implements Nix language strings and their different
|
|
||||||
/// backing implementations.
|
|
||||||
|
|
||||||
#[derive(Clone, Debug)]
|
#[derive(Clone, Debug)]
|
||||||
enum StringRepr {
|
enum StringRepr {
|
||||||
Smol(SmolStr),
|
Smol(SmolStr),
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/// Warnings are emitted in cases where code passed to Tvix exhibits
|
//! Implements warnings that are emitted in cases where code passed to
|
||||||
/// problems that the user could address.
|
//! Tvix exhibits problems that the user could address.
|
||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub enum WarningKind {
|
pub enum WarningKind {
|
||||||
|
|
Loading…
Reference in a new issue