Skip to content

Commit db4d24f

Browse files
committed
docs: update TUTORIAL.md to clarify camelCase usage
1 parent 78997c2 commit db4d24f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/TUTORIAL.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Other classes implement useful behavior on top of [BaseService].
107107

108108
[baseservice]: https://contributing.shields.io/module-core_base-service_base.html
109109

110-
As a first step we will look at the code for an example which generates a badge without contacting an API.
110+
As a first step we will look at the code for an example which generates a badge without contacting an API. Note that camelCase should be used for variables, functions, and path/query parameters.
111111

112112
```js
113113
// (1)
@@ -346,6 +346,8 @@ export default class GemVersion extends BaseJsonService {
346346

347347
but we have used the helper function `pathParams` to imply some defaults and reduce the amount of code we need to write by hand.
348348

349+
7. Path and query parameters should be camelCase, for example use `gemName` instead of `gem_name`.
350+
349351
Save, run `npm start`, and you can see it [locally](http://127.0.0.1:3000/).
350352

351353
If you update `openApi`, you don't have to restart the server. Run `npm run prestart` in another terminal window and the frontend will update.

0 commit comments

Comments
 (0)