OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-22 14:35:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Apply suggestions from code review

Browse source 
Co-authored-by: Hirrolot <hirrolot@gmail.com>
This commit is contained in:
Waffle Maybe 2022-10-03 20:49:25 +04:00 committed by GitHub
parent 1b983e043f
commit 243bfa8460
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CODE_STYLE.md
View file

@ -42,7 +42,7 @@ impl<T: Trait> Trait for Wrap<T> { ... }
## 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<T: Trait> Trait for Wrap<T> { ... }
/// 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
<!-- GOOD -->
- Handle different kinds of Update