From 243bfa84608d0f70838658724d59a1238e8c6a28 Mon Sep 17 00:00:00 2001 From: Waffle Maybe Date: Mon, 3 Oct 2022 20:49:25 +0400 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Hirrolot --- CODE_STYLE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_STYLE.md b/CODE_STYLE.md index 67c3d42e..77803ce3 100644 --- a/CODE_STYLE.md +++ b/CODE_STYLE.md @@ -42,7 +42,7 @@ impl Trait for Wrap { ... } ## Documentation comments 1. Documentation must describe _what_ your code does and mustn't describe _how_ your code does it and bla-bla-bla. -2. Be sure that your comments follow the grammar, including punctuation, the first capital letter and so on. +2. Be sure that your comments follow the grammar, including punctuation, the first capital letter and so on: ```rust // GOOD /// This function makes a request to Telegram. @@ -52,7 +52,7 @@ impl Trait for Wrap { ... } /// this function make request to telegram pub fn make_request(url: &str) -> String { ... } ``` -3. Do not use ending punctuation in short list items (usually containing just one phrase or sentence). +3. Do not use ending punctuation in short list items (usually containing just one phrase or sentence): ```md - Handle different kinds of Update