mirror of
https://github.com/teloxide/teloxide.git
synced 2024-12-22 22:46:39 +01:00
Create CODE_STYLE.md
Related to https://github.com/teloxide/teloxide/issues/55.
This commit is contained in:
parent
586d7eced7
commit
7444d016f1
1 changed files with 26 additions and 0 deletions
26
CODE_STYLE.md
Normal file
26
CODE_STYLE.md
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
# Code style
|
||||||
|
This is a description of a coding style that every contributor must follow. Please, read the whole document before you start pushing code.
|
||||||
|
|
||||||
|
## Generics
|
||||||
|
Generics are always written with `where`.
|
||||||
|
|
||||||
|
Bad:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
pub fn new<N: Into<String>,
|
||||||
|
T: Into<String>,
|
||||||
|
P: Into<InputFile>,
|
||||||
|
E: Into<String>>
|
||||||
|
(user_id: i32, name: N, title: T, png_sticker: P, emojis: E) -> Self { ... }
|
||||||
|
```
|
||||||
|
|
||||||
|
Good:
|
||||||
|
|
||||||
|
```rust
|
||||||
|
pub fn new<N, T, P, E>(user_id: i32, name: N, title: T, png_sticker: P, emojis: E) -> Self
|
||||||
|
where
|
||||||
|
N: Into<String>,
|
||||||
|
T: Into<String>,
|
||||||
|
P: Into<InputFile>,
|
||||||
|
E: Into<String> { ... }
|
||||||
|
```
|
Loading…
Reference in a new issue