Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 91ef862

Browse filesBrowse files
lundibundidanielleadams
authored andcommitted
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
Copy full SHA for 91ef862

File tree

Expand file treeCollapse file tree

1 file changed

+11
-1
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+11
-1
lines changed
Open diff view settings
Collapse file

‎doc/guides/contributing/pull-requests.md‎

Copy file name to clipboardExpand all lines: doc/guides/contributing/pull-requests.md
+11-1Lines changed: 11 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.