Commit 91ef862
doc: mention adding YAML for APIs in PR contributing guide
PR-URL: #35459
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Mary Marchini <oss@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>1 parent 885840b commit 91ef862
1 file changed
Lines changed: 11 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -130,7 +130,17 @@ Any documentation you write (including code comments and API documentation) | |||
| 130 | 130 | should follow the [Style Guide](../doc-style-guide.md). Code samples | |
| 131 | 131 | included in the API docs will also be checked when running `make lint` (or | |
| 132 | 132 | `vcbuild.bat lint` on Windows). If you are adding to or deprecating an API, | |
| 133 | - use `REPLACEME` for the version number in the documentation YAML. | ||
| 133 | + add or change the appropriate YAML documentation. Use `REPLACEME` for the | ||
| 134 | + version number in the documentation YAML: | ||
| 135 | + | ||
| 136 | + ```markdown | ||
| 137 | + ### `request.method` | ||
| 138 | + <!-- YAML | ||
| 139 | + added: REPLACEME | ||
| 140 | + --> | ||
| 141 | + | ||
| 142 | + * {string} The request method. | ||
| 143 | + ``` | ||
| 134 | 144 | ||
| 135 | 145 | For contributing C++ code, you may want to look at the | |
| 136 | 146 | [C++ Style Guide](../cpp-style-guide.md), as well as the | |
0 commit comments