Skip to content

Commit c182f7e

Browse files
committed
review
1 parent f994dc3 commit c182f7e

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

website/docs/contributing/add-new-language.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ This parameter **must** be the last parameter of a method, and allow a user to o
144144

145145
### Requesters
146146

147-
The requester needs to be configurable, or overwriten completely and use a user defined requester.
148-
The default requester must be the classic HTTP requester, and it's possible to provide other alternatives like an Echo Requester that just send the request back.
147+
The requester needs to be configurable and capable to be overwriten to use a user defined requester.
148+
The default requester must be the classic HTTP requester, and it's possible to provide other alternatives like an [Echo Requester](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/client-common/src/createEchoRequester.ts) that just send the request back.
149149

150150
### Logger
151151

website/docs/contributing/testing/common-test-suite.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Common Test Suite
55
# Common Test Suite
66

77
The CTS gather multiple types of tests that make sure our API clients generate the correct requests and throws the correct error, it does not aim at testing the engine.
8-
It is automatically generated for all languages, from JSON files and the specs.
8+
It is automatically generated for all languages from JSON files and ensure properties are valid by checking specs.
99

1010
:::info
1111

@@ -72,7 +72,7 @@ The test generation script requires a JSON file name from the `operationId` (e.g
7272
And that's it! If the name of the file matches an `operationId` in the spec, a test will be generated and will be calling the method name `operationId`.
7373

7474
The list of `queryParameters` must match exactly the actual value, the CTS has to check the number of query parameters and the value of each.
75-
It's important to ensure the number of parameters because the API clients must not set default values, they should be handled by the engine.
75+
**It's important to ensure the number of parameters because the API clients must not set default values, they should be handled by the engine.**
7676

7777
### Clients tests
7878

@@ -190,16 +190,16 @@ When writing your template, here is a list of variables accessible from `mustach
190190
```
191191

192192
As well as lambdas to transform strings:
193-
- escapeQuotes - Escapes double quotes characters, replaces `"` with `\"`.
194-
- escapeSlash - Escapes backward slash characters, replaces `\` with `\\`.
195-
- lowercase - Converts all of the characters in this fragment to lower case using the rules of the ROOT locale.
196-
- uppercase - Converts all of the characters in this fragment to upper case using the rules of the ROOT locale.
197-
- titlecase - Converts text in a fragment to title case. For example once upon a time to Once Upon A Time.
198-
- camelcase - Converts text in a fragment to camelCase. For example Input-text to inputText.
199-
- indented - Prepends 4 spaces indention from second line of a fragment on. First line will be indented by Mustache.
200-
- indented_8 - Prepends 8 spaces indention from second line of a fragment on. First line will be indented by Mustache.
201-
- indented_12 - Prepends 12 spaces indention from second line of a fragment on. First line will be indented by Mustache.
202-
- indented_16 - Prepends 16 spaces indention from second line of a fragment on. First line will be indented by Mustache.
193+
- `escapeQuotes` - Escapes double quotes characters, replaces `"` with `\"`.
194+
- `escapeSlash` - Escapes backward slash characters, replaces `\` with `\\`.
195+
- `lowercase` - Converts all of the characters in this fragment to lower case using the rules of the ROOT locale.
196+
- `uppercase` - Converts all of the characters in this fragment to upper case using the rules of the ROOT locale.
197+
- `titlecase` - Converts text in a fragment to title case. For example once upon a time to Once Upon A Time.
198+
- `camelcase` - Converts text in a fragment to camelCase. For example Input-text to inputText.
199+
- `indented` - Prepends 4 spaces indention from second line of a fragment on. First line will be indented by Mustache.
200+
- `indented_8` - Prepends 8 spaces indention from second line of a fragment on. First line will be indented by Mustache.
201+
- `indented_12` - Prepends 12 spaces indention from second line of a fragment on. First line will be indented by Mustache.
202+
- `indented_16` - Prepends 16 spaces indention from second line of a fragment on. First line will be indented by Mustache.
203203

204204
If specific values are needed for a specific languages, or custom generated files, they can be added using a custom CTS manager:
205205
- [javascript](https://github.com/algolia/api-clients-automation/blob/main/generators/src/main/java/com/algolia/codegen/cts/manager/JavaScriptCTSManager.java)

0 commit comments

Comments
 (0)