Skip to content
Permalink
Browse files
[FLINK-18309] Recommend avoiding uppercase to emphasise statements in…
… doc style

This closes #351.
  • Loading branch information
azagrebin committed Jun 16, 2020
1 parent ac41805 commit e6d47b6c0ab23cea0068ac6b710adff37e3cd934
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
@@ -68,6 +68,15 @@ Principles](#general-guiding-principles).
struggling to complete an action, using words like _quick_ or _easy_ can lead
to a poor documentation experience.

* **Avoid using uppercase words** to highlight or emphasize statements.
Highlighting key words with e.g. **bold** or _italic_ font usually appears more polite.
If you want to draw attention to important but not obvious statements,
try to group them into separate paragraphs starting with a label,
highlighted with a corresponding HTML tag:
* `<span class="label label-info">Note</span>`
* `<span class="label label-warning">Warning</span>`
* `<span class="label label-danger">Danger</span>`

### Using Flink-specific Terms

Use clear definitions of terms or provide additional instructions on what
@@ -68,6 +68,15 @@ Principles](#general-guiding-principles).
struggling to complete an action, using words like _quick_ or _easy_ can lead
to a poor documentation experience.

* **Avoid using uppercase words** to highlight or emphasize statements.
Highlighting key words with e.g. **bold** or _italic_ font usually appears more polite.
If you want to draw attention to important but not obvious statements,
try to group them into separate paragraphs starting with a label,
highlighted with a corresponding HTML tag:
* `<span class="label label-info">Note</span>`
* `<span class="label label-warning">Warning</span>`
* `<span class="label label-danger">Danger</span>`

### Using Flink-specific Terms

Use clear definitions of terms or provide additional instructions on what

0 comments on commit e6d47b6

Please sign in to comment.