Skip to content

Commit 9a285e7

Browse files
pquentinflobernd
andauthored
Update doc comments guidelines (#3037) (#3412)
(cherry picked from commit ddf9cd9) Co-authored-by: Florian Bernd <[email protected]>
1 parent 7826a6f commit 9a285e7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/doc-comments-guide.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,20 @@ Documentation of the TypeScript specification is made using [JSDoc](https://jsdo
77
The first phrase is used as the mandatory operation summary in the OpenAPI document.
88
Refer to [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries).
99

10-
NOTE: You must add a period or `\n` at the end of the phrase for it to parse correctly.
11-
The period will be properly omitted from the output OpenAPI document.
10+
> [!NOTE]
11+
> You must add a period at the end of the phrase for it to parse correctly. The period will be properly omitted from the output OpenAPI document.
1212
1313
Additional lines start with a `*` followed by a space. Long lines are allowed but it's better if text is formatted to a maximum of 120 characters per line.
1414

15+
> [!NOTE]
16+
> A blank line must be inserted between the first sentence and all subsequent lines to ensure correct formatting in all places (e.g. in the in-code documentation of the language clients).
17+
1518
## Example
1619

1720
```ts
1821
/**
1922
* Get ranking evaluation.
23+
*
2024
* Enables you to evaluate the quality of ranked search results over a set of typical search queries.
2125
* @rest_spec_name rank_eval
2226
* @availability stack since=6.2.0 stability=stable

0 commit comments

Comments
 (0)