Skip to content

Commit f9646ed

Browse files
committed
Update docs for compiler
Add docs for struct Customize and replace codes with code for 'code' is uncountable Signed-off-by: Tim Zhang <[email protected]>
1 parent 38a5871 commit f9646ed

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

compiler/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# A compiler of ttrpc-rust
22

3-
generate rust version ttrpc codes from proto files.
3+
generate rust version ttrpc code from proto files.
44

55
## Usage
66

compiler/src/lib.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
//!
1515
//! A compiler of ttrpc-rust.
1616
//!
17-
//! *generate rust version ttrpc codes from proto files.*
17+
//! *generate rust version ttrpc code from proto files.*
1818
//!
1919
//!
2020
//! Usage
@@ -27,9 +27,13 @@ pub mod codegen;
2727
pub mod prost_codegen;
2828
mod util;
2929

30+
/// Customize generated code.
3031
#[derive(Default, Debug, Clone)]
3132
pub struct Customize {
33+
/// Indicates whether to generate async code for both server and client.
3234
pub async_all: bool,
35+
/// Indicates whether to generate async code for client.
3336
pub async_client: bool,
37+
/// Indicates whether to generate async code for server.
3438
pub async_server: bool,
3539
}

0 commit comments

Comments
 (0)