Skip to content

Commit 91ef862

Browse files
lundibundidanielleadams
authored andcommitted
doc: mention adding YAML for APIs in PR contributing guide
PR-URL: #35459 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 885840b commit 91ef862

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

doc/guides/contributing/pull-requests.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,17 @@ Any documentation you write (including code comments and API documentation)
130130
should follow the [Style Guide](../doc-style-guide.md). Code samples
131131
included in the API docs will also be checked when running `make lint` (or
132132
`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+
```
134144

135145
For contributing C++ code, you may want to look at the
136146
[C++ Style Guide](../cpp-style-guide.md), as well as the

0 commit comments

Comments
 (0)