From 88a4ee01d338e14990de646ed860c4cf412edb3e Mon Sep 17 00:00:00 2001 From: "Adam H. Leventhal" Date: Tue, 10 Mar 2020 09:57:37 -0700 Subject: [PATCH] fix error regarding block comments --- style-guide/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/style-guide/README.md b/style-guide/README.md index 9e6888cb6..adb73a7ee 100644 --- a/style-guide/README.md +++ b/style-guide/README.md @@ -121,10 +121,10 @@ smaller: #### Doc comments -Prefer line comments (`///`) to block comments (`//* ... */`). +Prefer line comments (`///`) to block comments (`/** ... */`). -Prefer outer doc comments (`///` or `//*`), only use inner doc comments (`//!` -and `//*!`) to write module-level or crate-level documentation. +Prefer outer doc comments (`///` or `/** ... */`), only use inner doc comments +(`//!` and `/*! ... */`) to write module-level or crate-level documentation. Doc comments should come before attributes.