From fb20db98cda1a68d5d35018c4933906f1f74cb98 Mon Sep 17 00:00:00 2001 From: Jeehoon Kang Date: Sun, 18 Jun 2023 19:11:19 +0000 Subject: [PATCH] Fix doc --- rust-toolchain | 2 +- src/assignments/assignment03.rs | 2 +- src/assignments/assignment04/syntax.rs | 2 +- src/assignments/assignment10.rs | 2 +- src/assignments/assignment11/tv_room.rs | 2 +- src/lib.rs | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/rust-toolchain b/rust-toolchain index 4934985..832e9af 100644 --- a/rust-toolchain +++ b/rust-toolchain @@ -1 +1 @@ -1.69.0 +1.70.0 diff --git a/src/assignments/assignment03.rs b/src/assignments/assignment03.rs index f51b26c..68d22da 100644 --- a/src/assignments/assignment03.rs +++ b/src/assignments/assignment03.rs @@ -158,7 +158,7 @@ pub fn piglatin(input: String) -> String { /// /// - The result is a map from department to the list of its employees. /// - An empty department should not appear in the result. -/// - There are three commands: "Add to ", "Remove from ", and "Move from to ". +/// - There are three commands: "Add {person} to {department}", "Remove {person} from {department}", and "Move {person} from {department} to {department}". /// - If a command is not executable, then it's ignored. /// - There is no space in the name of the person and department. /// diff --git a/src/assignments/assignment04/syntax.rs b/src/assignments/assignment04/syntax.rs index 9f5ddd4..a4679b7 100644 --- a/src/assignments/assignment04/syntax.rs +++ b/src/assignments/assignment04/syntax.rs @@ -1,6 +1,6 @@ //! Syntax. -/// Command of the form "" or " = ". +/// Command of the form "{expression}" or "{var} = {expression}". #[derive(Debug, Clone, PartialEq)] pub struct Command { /// Variable (lhs). diff --git a/src/assignments/assignment10.rs b/src/assignments/assignment10.rs index 6a84161..6e3e510 100644 --- a/src/assignments/assignment10.rs +++ b/src/assignments/assignment10.rs @@ -47,7 +47,7 @@ pub enum Node { /// /// For example, the result of preorder traversal for the following tree /// -/// ```ignore +/// ```text /// 1 /// /|\ /// 2 3 4 diff --git a/src/assignments/assignment11/tv_room.rs b/src/assignments/assignment11/tv_room.rs index 0315341..a3cec53 100644 --- a/src/assignments/assignment11/tv_room.rs +++ b/src/assignments/assignment11/tv_room.rs @@ -9,7 +9,7 @@ //! - Manager can leave the TV room earlier than guests. //! - The TV room closes when the last person left the TV room. //! -//! Both `Manager` and `Guest` have 'Rc' as a field, and its reference count indicates the number of people in +//! Both `Manager` and `Guest` have `Rc` as a field, and its reference count indicates the number of people in //! the TV room. When the 'Manager' and 'Guest' object is dropped, it means that the person leaves the TV room. //! //! Consult the following documentations: diff --git a/src/lib.rs b/src/lib.rs index 7c36a8a..3f4de86 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -21,7 +21,7 @@ #![deny(variant_size_differences)] #![deny(warnings)] #![deny(rustdoc::invalid_html_tags)] -#![deny(rustdoc::missing_doc_code_examples)] +// #![deny(rustdoc::missing_doc_code_examples)] #![deny(missing_docs)] #![deny(rustdoc::all)] #![deny(unreachable_pub)]