Skip to content

Commit

Permalink
Add exception for using future tense (#543)
Browse files Browse the repository at this point in the history
* chore: add exception for using future tense

* Apply suggestions from code review

Co-authored-by: Jack Baldry <[email protected]>

---------

Co-authored-by: Jack Baldry <[email protected]>
  • Loading branch information
heitortsergent and jdbaldry authored Feb 27, 2024
1 parent 866e27c commit 0594be7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/sources/write/style-guide/style-conventions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,23 @@ Make content relevant to the user's context. The more familiar you are with the

When you write in present tense, avoid words such as have, has, had, been, should, would, and will.

<!-- vale Grafana.GoogleWill = NO -->
<!-- This sentence is demonstrating an exception where this rule doesn't apply. -->

However, similar to [Google's style guide](https://developers.google.com/style/tense), it's okay to use future tense (will) when writing [tutorials](https://grafana.com/docs/writers-toolkit/structure/topic-types/tutorial/) or to distinguish an action that will occur in the future.

<!-- vale Grafana.GoogleWill = YES -->
<!-- vale Grafana.GoogleWill = NO -->
<!-- The table includes a demonstration of an acceptable use of the word will in the context of tutorials. -->

| Use | Don't use |
| ------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| The panel opens. | The panel will open. |
| The system **prompts** you to verify the deletion. | The system **will prompt** you to verify the deletion. |
| After you log in, your account **begins** the verification process. | After you log in, your account **will then begin** the verification process. |
| In this tutorial, you will: |

<!-- vale Grafana.GoogleWill = YES -->

### Be positive

Expand Down

0 comments on commit 0594be7

Please sign in to comment.