Skip to content

Commit e9ab6a7

Browse files
gyuhogyuho
committed
remove `` for texts in chart
1 parent 185d21e commit e9ab6a7

File tree

3 files changed

+65
-65
lines changed

3 files changed

+65
-65
lines changed

‎parse/markdown.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func (p *Proto) Markdown(title, fpath string, lopts ...string) error {
4141
buf.WriteString(hd1 + "\n")
4242
buf.WriteString(hd2 + "\n")
4343
for _, elem := range svs.Methods {
44-
line := fmt.Sprintf("| %s | `%s` | `%s` | %s |", elem.Name, elem.RequestType, elem.ResponseType, elem.Description)
44+
line := fmt.Sprintf("| %s | %s | %s | %s |", elem.Name, elem.RequestType, elem.ResponseType, elem.Description)
4545
buf.WriteString(line + "\n")
4646
}
4747
} else {

‎parse/testdata/README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55

66
| Method | Request Type | Response Type | Description |
77
| ------ | ------------ | ------------- | ----------- |
8-
| AuthEnable | `AuthEnableRequest` | `AuthEnableResponse` | AuthEnable enables authentication. |
9-
| AuthDisable | `AuthDisableRequest` | `AuthDisableResponse` | AuthDisable disables authentication. |
10-
| Authenticate | `AuthenticateRequest` | `AuthenticateResponse` | Authenticate processes authenticate request. |
11-
| UserAdd | `AuthUserAddRequest` | `AuthUserAddResponse` | UserAdd adds a new user. |
12-
| UserGet | `AuthUserGetRequest` | `AuthUserGetResponse` | UserGet gets a detailed information of a user or lists entire users. |
13-
| UserDelete | `AuthUserDeleteRequest` | `AuthUserDeleteResponse` | UserDelete deletes a specified user. |
14-
| UserChangePassword | `AuthUserChangePasswordRequest` | `AuthUserChangePasswordResponse` | UserChangePassword changes password of a specified user. |
15-
| UserGrant | `AuthUserGrantRequest` | `AuthUserGrantResponse` | UserGrant grants a role to a specified user. |
16-
| UserRevoke | `AuthUserRevokeRequest` | `AuthUserRevokeResponse` | UserRevoke revokes a role of specified user. |
17-
| RoleAdd | `AuthRoleAddRequest` | `AuthRoleAddResponse` | RoleAdd adds a new role. |
18-
| RoleGet | `AuthRoleGetRequest` | `AuthRoleGetResponse` | RoleGet gets a detailed information of a role or lists entire roles. |
19-
| RoleDelete | `AuthRoleDeleteRequest` | `AuthRoleDeleteResponse` | RoleDelete deletes a specified role. |
20-
| RoleGrant | `AuthRoleGrantRequest` | `AuthRoleGrantResponse` | RoleGrant grants a permission of a specified key or range to a specified role. |
21-
| RoleRevoke | `AuthRoleRevokeRequest` | `AuthRoleRevokeResponse` | RoleRevoke revokes a key or range permission of a specified role. |
8+
| AuthEnable | AuthEnableRequest | AuthEnableResponse | AuthEnable enables authentication. |
9+
| AuthDisable | AuthDisableRequest | AuthDisableResponse | AuthDisable disables authentication. |
10+
| Authenticate | AuthenticateRequest | AuthenticateResponse | Authenticate processes authenticate request. |
11+
| UserAdd | AuthUserAddRequest | AuthUserAddResponse | UserAdd adds a new user. |
12+
| UserGet | AuthUserGetRequest | AuthUserGetResponse | UserGet gets a detailed information of a user or lists entire users. |
13+
| UserDelete | AuthUserDeleteRequest | AuthUserDeleteResponse | UserDelete deletes a specified user. |
14+
| UserChangePassword | AuthUserChangePasswordRequest | AuthUserChangePasswordResponse | UserChangePassword changes password of a specified user. |
15+
| UserGrant | AuthUserGrantRequest | AuthUserGrantResponse | UserGrant grants a role to a specified user. |
16+
| UserRevoke | AuthUserRevokeRequest | AuthUserRevokeResponse | UserRevoke revokes a role of specified user. |
17+
| RoleAdd | AuthRoleAddRequest | AuthRoleAddResponse | RoleAdd adds a new role. |
18+
| RoleGet | AuthRoleGetRequest | AuthRoleGetResponse | RoleGet gets a detailed information of a role or lists entire roles. |
19+
| RoleDelete | AuthRoleDeleteRequest | AuthRoleDeleteResponse | RoleDelete deletes a specified role. |
20+
| RoleGrant | AuthRoleGrantRequest | AuthRoleGrantResponse | RoleGrant grants a permission of a specified key or range to a specified role. |
21+
| RoleRevoke | AuthRoleRevokeRequest | AuthRoleRevokeResponse | RoleRevoke revokes a key or range permission of a specified role. |
2222

2323

2424
<br>
@@ -27,10 +27,10 @@
2727

2828
| Method | Request Type | Response Type | Description |
2929
| ------ | ------------ | ------------- | ----------- |
30-
| MemberAdd | `MemberAddRequest` | `MemberAddResponse` | MemberAdd adds a member into the cluster. |
31-
| MemberRemove | `MemberRemoveRequest` | `MemberRemoveResponse` | MemberRemove removes an existing member from the cluster. |
32-
| MemberUpdate | `MemberUpdateRequest` | `MemberUpdateResponse` | MemberUpdate updates the member configuration. |
33-
| MemberList | `MemberListRequest` | `MemberListResponse` | MemberList lists all the members in the cluster. |
30+
| MemberAdd | MemberAddRequest | MemberAddResponse | MemberAdd adds a member into the cluster. |
31+
| MemberRemove | MemberRemoveRequest | MemberRemoveResponse | MemberRemove removes an existing member from the cluster. |
32+
| MemberUpdate | MemberUpdateRequest | MemberUpdateResponse | MemberUpdate updates the member configuration. |
33+
| MemberList | MemberListRequest | MemberListResponse | MemberList lists all the members in the cluster. |
3434

3535

3636
<br>
@@ -39,11 +39,11 @@
3939

4040
| Method | Request Type | Response Type | Description |
4141
| ------ | ------------ | ------------- | ----------- |
42-
| Range | `RangeRequest` | `RangeResponse` | Range gets the keys in the range from the store. |
43-
| Put | `PutRequest` | `PutResponse` | Put puts the given key into the store. A put request increases the revision of the store, and generates one event in the event history. |
44-
| DeleteRange | `DeleteRangeRequest` | `DeleteRangeResponse` | Delete deletes the given range from the store. A delete request increase the revision of the store, and generates one event in the event history. |
45-
| Txn | `TxnRequest` | `TxnResponse` | Txn processes all the requests in one transaction. A txn request increases the revision of the store, and generates events with the same revision in the event history. It is not allowed to modify the same key several times within one txn. |
46-
| Compact | `CompactionRequest` | `CompactionResponse` | Compact compacts the event history in etcd. User should compact the event history periodically, or it will grow infinitely. |
42+
| Range | RangeRequest | RangeResponse | Range gets the keys in the range from the store. |
43+
| Put | PutRequest | PutResponse | Put puts the given key into the store. A put request increases the revision of the store, and generates one event in the event history. |
44+
| DeleteRange | DeleteRangeRequest | DeleteRangeResponse | Delete deletes the given range from the store. A delete request increase the revision of the store, and generates one event in the event history. |
45+
| Txn | TxnRequest | TxnResponse | Txn processes all the requests in one transaction. A txn request increases the revision of the store, and generates events with the same revision in the event history. It is not allowed to modify the same key several times within one txn. |
46+
| Compact | CompactionRequest | CompactionResponse | Compact compacts the event history in etcd. User should compact the event history periodically, or it will grow infinitely. |
4747

4848

4949
<br>
@@ -52,9 +52,9 @@
5252

5353
| Method | Request Type | Response Type | Description |
5454
| ------ | ------------ | ------------- | ----------- |
55-
| LeaseGrant | `LeaseGrantRequest` | `LeaseGrantResponse` | LeaseGrant creates a lease. A lease has a TTL. The lease will expire if the server does not receive a keepAlive within TTL from the lease holder. All keys attached to the lease will be expired and deleted if the lease expires. The key expiration generates an event in event history. |
56-
| LeaseRevoke | `LeaseRevokeRequest` | `LeaseRevokeResponse` | LeaseRevoke revokes a lease. All the key attached to the lease will be expired and deleted. |
57-
| LeaseKeepAlive | `LeaseKeepAliveRequest` | `LeaseKeepAliveResponse` | KeepAlive keeps the lease alive. |
55+
| LeaseGrant | LeaseGrantRequest | LeaseGrantResponse | LeaseGrant creates a lease. A lease has a TTL. The lease will expire if the server does not receive a keepAlive within TTL from the lease holder. All keys attached to the lease will be expired and deleted if the lease expires. The key expiration generates an event in event history. |
56+
| LeaseRevoke | LeaseRevokeRequest | LeaseRevokeResponse | LeaseRevoke revokes a lease. All the key attached to the lease will be expired and deleted. |
57+
| LeaseKeepAlive | LeaseKeepAliveRequest | LeaseKeepAliveResponse | KeepAlive keeps the lease alive. |
5858

5959

6060
<br>
@@ -63,11 +63,11 @@
6363

6464
| Method | Request Type | Response Type | Description |
6565
| ------ | ------------ | ------------- | ----------- |
66-
| Alarm | `AlarmRequest` | `AlarmResponse` | Alarm activates, deactivates, and queries alarms regarding cluster health. |
67-
| Status | `StatusRequest` | `StatusResponse` | Status gets the status of the member. |
68-
| Defragment | `DefragmentRequest` | `DefragmentResponse` | |
69-
| Hash | `HashRequest` | `HashResponse` | Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions. |
70-
| Snapshot | `SnapshotRequest` | `SnapshotResponse` | Snapshot sends a snapshot of the entire backend |
66+
| Alarm | AlarmRequest | AlarmResponse | Alarm activates, deactivates, and queries alarms regarding cluster health. |
67+
| Status | StatusRequest | StatusResponse | Status gets the status of the member. |
68+
| Defragment | DefragmentRequest | DefragmentResponse | |
69+
| Hash | HashRequest | HashResponse | Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions. |
70+
| Snapshot | SnapshotRequest | SnapshotResponse | Snapshot sends a snapshot of the entire backend |
7171

7272

7373
<br>
@@ -76,7 +76,7 @@
7676

7777
| Method | Request Type | Response Type | Description |
7878
| ------ | ------------ | ------------- | ----------- |
79-
| Watch | `WatchRequest` | `WatchResponse` | Watch watches the events happening or happened. Both input and output are stream. One watch rpc can watch for multiple keys or prefixs and get a stream of events. The whole events history can be watched unless compacted. |
79+
| Watch | WatchRequest | WatchResponse | Watch watches the events happening or happened. Both input and output are stream. One watch rpc can watch for multiple keys or prefixs and get a stream of events. The whole events history can be watched unless compacted. |
8080

8181

8282
<br>

‎sample.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55

66
| Method | Request Type | Response Type | Description |
77
| ------ | ------------ | ------------- | ----------- |
8-
| AuthEnable | `AuthEnableRequest` | `AuthEnableResponse` | AuthEnable enables authentication. |
9-
| AuthDisable | `AuthDisableRequest` | `AuthDisableResponse` | AuthDisable disables authentication. |
10-
| Authenticate | `AuthenticateRequest` | `AuthenticateResponse` | Authenticate processes authenticate request. |
11-
| UserAdd | `AuthUserAddRequest` | `AuthUserAddResponse` | UserAdd adds a new user. |
12-
| UserGet | `AuthUserGetRequest` | `AuthUserGetResponse` | UserGet gets a detailed information of a user or lists entire users. |
13-
| UserDelete | `AuthUserDeleteRequest` | `AuthUserDeleteResponse` | UserDelete deletes a specified user. |
14-
| UserChangePassword | `AuthUserChangePasswordRequest` | `AuthUserChangePasswordResponse` | UserChangePassword changes password of a specified user. |
15-
| UserGrant | `AuthUserGrantRequest` | `AuthUserGrantResponse` | UserGrant grants a role to a specified user. |
16-
| UserRevoke | `AuthUserRevokeRequest` | `AuthUserRevokeResponse` | UserRevoke revokes a role of specified user. |
17-
| RoleAdd | `AuthRoleAddRequest` | `AuthRoleAddResponse` | RoleAdd adds a new role. |
18-
| RoleGet | `AuthRoleGetRequest` | `AuthRoleGetResponse` | RoleGet gets a detailed information of a role or lists entire roles. |
19-
| RoleDelete | `AuthRoleDeleteRequest` | `AuthRoleDeleteResponse` | RoleDelete deletes a specified role. |
20-
| RoleGrant | `AuthRoleGrantRequest` | `AuthRoleGrantResponse` | RoleGrant grants a permission of a specified key or range to a specified role. |
21-
| RoleRevoke | `AuthRoleRevokeRequest` | `AuthRoleRevokeResponse` | RoleRevoke revokes a key or range permission of a specified role. |
8+
| AuthEnable | AuthEnableRequest | AuthEnableResponse | AuthEnable enables authentication. |
9+
| AuthDisable | AuthDisableRequest | AuthDisableResponse | AuthDisable disables authentication. |
10+
| Authenticate | AuthenticateRequest | AuthenticateResponse | Authenticate processes authenticate request. |
11+
| UserAdd | AuthUserAddRequest | AuthUserAddResponse | UserAdd adds a new user. |
12+
| UserGet | AuthUserGetRequest | AuthUserGetResponse | UserGet gets a detailed information of a user or lists entire users. |
13+
| UserDelete | AuthUserDeleteRequest | AuthUserDeleteResponse | UserDelete deletes a specified user. |
14+
| UserChangePassword | AuthUserChangePasswordRequest | AuthUserChangePasswordResponse | UserChangePassword changes password of a specified user. |
15+
| UserGrant | AuthUserGrantRequest | AuthUserGrantResponse | UserGrant grants a role to a specified user. |
16+
| UserRevoke | AuthUserRevokeRequest | AuthUserRevokeResponse | UserRevoke revokes a role of specified user. |
17+
| RoleAdd | AuthRoleAddRequest | AuthRoleAddResponse | RoleAdd adds a new role. |
18+
| RoleGet | AuthRoleGetRequest | AuthRoleGetResponse | RoleGet gets a detailed information of a role or lists entire roles. |
19+
| RoleDelete | AuthRoleDeleteRequest | AuthRoleDeleteResponse | RoleDelete deletes a specified role. |
20+
| RoleGrant | AuthRoleGrantRequest | AuthRoleGrantResponse | RoleGrant grants a permission of a specified key or range to a specified role. |
21+
| RoleRevoke | AuthRoleRevokeRequest | AuthRoleRevokeResponse | RoleRevoke revokes a key or range permission of a specified role. |
2222

2323

2424
<br>
@@ -27,10 +27,10 @@
2727

2828
| Method | Request Type | Response Type | Description |
2929
| ------ | ------------ | ------------- | ----------- |
30-
| MemberAdd | `MemberAddRequest` | `MemberAddResponse` | MemberAdd adds a member into the cluster. |
31-
| MemberRemove | `MemberRemoveRequest` | `MemberRemoveResponse` | MemberRemove removes an existing member from the cluster. |
32-
| MemberUpdate | `MemberUpdateRequest` | `MemberUpdateResponse` | MemberUpdate updates the member configuration. |
33-
| MemberList | `MemberListRequest` | `MemberListResponse` | MemberList lists all the members in the cluster. |
30+
| MemberAdd | MemberAddRequest | MemberAddResponse | MemberAdd adds a member into the cluster. |
31+
| MemberRemove | MemberRemoveRequest | MemberRemoveResponse | MemberRemove removes an existing member from the cluster. |
32+
| MemberUpdate | MemberUpdateRequest | MemberUpdateResponse | MemberUpdate updates the member configuration. |
33+
| MemberList | MemberListRequest | MemberListResponse | MemberList lists all the members in the cluster. |
3434

3535

3636
<br>
@@ -39,11 +39,11 @@
3939

4040
| Method | Request Type | Response Type | Description |
4141
| ------ | ------------ | ------------- | ----------- |
42-
| Range | `RangeRequest` | `RangeResponse` | Range gets the keys in the range from the store. |
43-
| Put | `PutRequest` | `PutResponse` | Put puts the given key into the store. A put request increases the revision of the store, and generates one event in the event history. |
44-
| DeleteRange | `DeleteRangeRequest` | `DeleteRangeResponse` | Delete deletes the given range from the store. A delete request increase the revision of the store, and generates one event in the event history. |
45-
| Txn | `TxnRequest` | `TxnResponse` | Txn processes all the requests in one transaction. A txn request increases the revision of the store, and generates events with the same revision in the event history. It is not allowed to modify the same key several times within one txn. |
46-
| Compact | `CompactionRequest` | `CompactionResponse` | Compact compacts the event history in etcd. User should compact the event history periodically, or it will grow infinitely. |
42+
| Range | RangeRequest | RangeResponse | Range gets the keys in the range from the store. |
43+
| Put | PutRequest | PutResponse | Put puts the given key into the store. A put request increases the revision of the store, and generates one event in the event history. |
44+
| DeleteRange | DeleteRangeRequest | DeleteRangeResponse | Delete deletes the given range from the store. A delete request increase the revision of the store, and generates one event in the event history. |
45+
| Txn | TxnRequest | TxnResponse | Txn processes all the requests in one transaction. A txn request increases the revision of the store, and generates events with the same revision in the event history. It is not allowed to modify the same key several times within one txn. |
46+
| Compact | CompactionRequest | CompactionResponse | Compact compacts the event history in etcd. User should compact the event history periodically, or it will grow infinitely. |
4747

4848

4949
<br>
@@ -52,9 +52,9 @@
5252

5353
| Method | Request Type | Response Type | Description |
5454
| ------ | ------------ | ------------- | ----------- |
55-
| LeaseGrant | `LeaseGrantRequest` | `LeaseGrantResponse` | LeaseGrant creates a lease. A lease has a TTL. The lease will expire if the server does not receive a keepAlive within TTL from the lease holder. All keys attached to the lease will be expired and deleted if the lease expires. The key expiration generates an event in event history. |
56-
| LeaseRevoke | `LeaseRevokeRequest` | `LeaseRevokeResponse` | LeaseRevoke revokes a lease. All the key attached to the lease will be expired and deleted. |
57-
| LeaseKeepAlive | `LeaseKeepAliveRequest` | `LeaseKeepAliveResponse` | KeepAlive keeps the lease alive. |
55+
| LeaseGrant | LeaseGrantRequest | LeaseGrantResponse | LeaseGrant creates a lease. A lease has a TTL. The lease will expire if the server does not receive a keepAlive within TTL from the lease holder. All keys attached to the lease will be expired and deleted if the lease expires. The key expiration generates an event in event history. |
56+
| LeaseRevoke | LeaseRevokeRequest | LeaseRevokeResponse | LeaseRevoke revokes a lease. All the key attached to the lease will be expired and deleted. |
57+
| LeaseKeepAlive | LeaseKeepAliveRequest | LeaseKeepAliveResponse | KeepAlive keeps the lease alive. |
5858

5959

6060
<br>
@@ -63,11 +63,11 @@
6363

6464
| Method | Request Type | Response Type | Description |
6565
| ------ | ------------ | ------------- | ----------- |
66-
| Alarm | `AlarmRequest` | `AlarmResponse` | Alarm activates, deactivates, and queries alarms regarding cluster health. |
67-
| Status | `StatusRequest` | `StatusResponse` | Status gets the status of the member. |
68-
| Defragment | `DefragmentRequest` | `DefragmentResponse` | |
69-
| Hash | `HashRequest` | `HashResponse` | Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions. |
70-
| Snapshot | `SnapshotRequest` | `SnapshotResponse` | Snapshot sends a snapshot of the entire backend |
66+
| Alarm | AlarmRequest | AlarmResponse | Alarm activates, deactivates, and queries alarms regarding cluster health. |
67+
| Status | StatusRequest | StatusResponse | Status gets the status of the member. |
68+
| Defragment | DefragmentRequest | DefragmentResponse | |
69+
| Hash | HashRequest | HashResponse | Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions. |
70+
| Snapshot | SnapshotRequest | SnapshotResponse | Snapshot sends a snapshot of the entire backend |
7171

7272

7373
<br>
@@ -76,7 +76,7 @@
7676

7777
| Method | Request Type | Response Type | Description |
7878
| ------ | ------------ | ------------- | ----------- |
79-
| Watch | `WatchRequest` | `WatchResponse` | Watch watches the events happening or happened. Both input and output are stream. One watch rpc can watch for multiple keys or prefixs and get a stream of events. The whole events history can be watched unless compacted. |
79+
| Watch | WatchRequest | WatchResponse | Watch watches the events happening or happened. Both input and output are stream. One watch rpc can watch for multiple keys or prefixs and get a stream of events. The whole events history can be watched unless compacted. |
8080

8181

8282
<br>

0 commit comments

Comments
 (0)