From 69b66bde4b2efa47a0f5ea6d2c02fa7bf6888bd3 Mon Sep 17 00:00:00 2001 From: Jack Baldry Date: Fri, 3 May 2024 14:58:45 +0100 Subject: [PATCH] Note that first person plural is fine when referring to Grafana Labs (#649) Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> --- vale/Grafana/GoogleWe.yml | 11 ----------- vale/Grafana/We.yml | 16 ++++++++++++++++ vale/google.jsonnet | 3 ++- 3 files changed, 18 insertions(+), 12 deletions(-) delete mode 100644 vale/Grafana/GoogleWe.yml create mode 100644 vale/Grafana/We.yml diff --git a/vale/Grafana/GoogleWe.yml b/vale/Grafana/GoogleWe.yml deleted file mode 100644 index 7605aaa1f..000000000 --- a/vale/Grafana/GoogleWe.yml +++ /dev/null @@ -1,11 +0,0 @@ -"extends": "existence" -"ignorecase": true -"level": "warning" -"link": "https://developers.google.com/style/pronouns#personal-pronouns" -"message": "Try to avoid using first-person plural like '%s'." -"tokens": - - "we" - - "we'(?:ve|re)" - - "ours?" - - "us" - - "let's" diff --git a/vale/Grafana/We.yml b/vale/Grafana/We.yml new file mode 100644 index 000000000..b468adb41 --- /dev/null +++ b/vale/Grafana/We.yml @@ -0,0 +1,16 @@ +extends: existence +message: | + Use first person plural pronouns like '%s' carefully. + + Don't use 'we' when you're talking about the reader, instead use 'you'. + + It's OK to use 'we' when you're talking about Grafana Labs. +link: https://developers.google.com/style/person#use-first-person-plural-pronouns-carefully +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/vale/google.jsonnet b/vale/google.jsonnet index c5f21a522..1fd15f11a 100644 --- a/vale/google.jsonnet +++ b/vale/google.jsonnet @@ -36,7 +36,8 @@ std.prune({ 'Grafana/GoogleSpelling.yml': std.manifestYamlDoc(std.parseYaml(importstr 'Google/Spelling.yml')), // More often than not, we need to be consistent with Prometheus units or units used Grafana UI which are not represented in the form encouraged by SI. 'Grafana/GoogleUnits.yml': null, - 'Grafana/GoogleWe.yml': std.manifestYamlDoc(std.parseYaml(importstr 'Google/We.yml')), + // Replaced by Grafana/We.yml. + 'Grafana/GoogleWe.yml': null, 'Grafana/GoogleWill.yml': std.manifestYamlDoc(std.parseYaml(importstr 'Google/Will.yml') { message: super.message + '\n\n' + ||| Use present tense for statements that describe general behavior that's not associated with a particular time.