diff --git a/IBMQuantum/Contractions.yml b/IBMQuantum/Contractions.yml new file mode 100644 index 0000000..5d69733 --- /dev/null +++ b/IBMQuantum/Contractions.yml @@ -0,0 +1,5 @@ +extends: existence +message: "Remove the hyphen in '%s'." +level: suggestion +tokens: + - 'non-(\w+)' diff --git a/IBMQuantum/However.yml b/IBMQuantum/However.yml index 458d21d..b605862 100644 --- a/IBMQuantum/However.yml +++ b/IBMQuantum/However.yml @@ -1,7 +1,6 @@ extends: existence message: Double-check your punctuation around 'however' (see github.com/IBM/ibm-quantum-style-guide/issues/10 for more information). level: suggestion -code: false -ignorecase: true +ignorecase: false raw: - ([^;,] however|however[^,]) diff --git a/IBMQuantum/Links.yml b/IBMQuantum/Links.yml index 963e595..b429b6f 100644 --- a/IBMQuantum/Links.yml +++ b/IBMQuantum/Links.yml @@ -1,16 +1,13 @@ extends: existence message: Link names should make sense without context; change "%s" to something more descriptive. level: suggestion -code: false -scope: link +scope: raw ignorecase: true tokens: - - click here - - here - - link - - more - - more information - - page - - read more - - this link - - this page + # Manually match markdown / rst links + - '(?<=\[)(click )?here(?=\](\s*?)\()' + - '(?<=`)(click )?here(?=((\s*?)<(.+?)>)?`_)' + - '(?<=\[)(read )?more( information)?(?=\](\s*?)\()' + - '(?<=`)(read )?more( information)?(?=((\s*?)<(.+?)>)?`_)' + - '(?<=\[)(this )?(link|page)(?=\](\s*?)\()' + - '(?<=`)(this )?(link|page)(?=((\s*?)<(.+?)>)?`_)' diff --git a/IBMQuantum/Politeness.yml b/IBMQuantum/Politeness.yml index 43bf697..8e2cb60 100644 --- a/IBMQuantum/Politeness.yml +++ b/IBMQuantum/Politeness.yml @@ -4,6 +4,6 @@ link: 'https://github.com/IBM/ibm-quantum-style-guide/issues/16' ignorecase: true level: error tokens: - - please + - 'please(?!\swait)' - thanks - thank you diff --git a/IBMQuantum/Terms.yml b/IBMQuantum/Terms.yml index 77527df..06b76f0 100644 --- a/IBMQuantum/Terms.yml +++ b/IBMQuantum/Terms.yml @@ -15,7 +15,6 @@ swap: 'pop-up (?:blocker|killer)': software to block pop-up ad windows 're(?:-)?occur': recur 'sort(?:-|/)?merge': sort|merge - 'do(?: )(?!not|so)': complete|perform bottom: end|last below: following @@ -143,6 +142,7 @@ swap: secondary storage: auxiliary storage selection button: left mouse button serial database: nonpartitioned database environment + set-up: setup shift-click: press Shift and click ship: include|included Simple Object Access Protocol: SOAP @@ -162,7 +162,6 @@ swap: toggle off: toggle tooling: tools touchscreen: touch-sensitive screen - transition: make the transition|move|migrate|change transparent: indiscernible|not visible typo: typing error|typographical error uncheck: clear diff --git a/dictionary.txt b/dictionary.txt index 81c20c1..cd00132 100644 --- a/dictionary.txt +++ b/dictionary.txt @@ -2,6 +2,7 @@ Abelian Abhinav Aer Akira +Alain Amyra Andersson Andriyash @@ -17,6 +18,7 @@ Bergholm Bernagozzi Bertels Bertet +Bluemix Boeblingen Boixo Boulant @@ -69,6 +71,7 @@ Hiptmair Hoyer Hubregtsen Ijaz +Ising Iten Izaac Jakob @@ -154,6 +157,7 @@ Vion Vivek Vojtech Volkoff +Watrous Weedbrook Wierichs Woerner @@ -188,9 +192,11 @@ eigensolver eigensolvers eigenstate eigenstates +enablement endian exponentials expressibility +extremal fanout fermionic fidelities @@ -208,6 +214,7 @@ orthonormality parameterization polynomially preprint +presigned priori pseudocode qiskit @@ -222,6 +229,7 @@ qutrits recalibrated reuploading satisfiability +serverless simulability subfield subfields @@ -231,6 +239,7 @@ substrings sudoku summand summands +timestep tooltip tooltips transmon @@ -243,3 +252,4 @@ transpiling tridiagonal trits unitaries +untrusted diff --git a/features/rules.feature b/features/rules.feature index 0262ef9..411d839 100644 --- a/features/rules.feature +++ b/features/rules.feature @@ -6,7 +6,6 @@ Feature: Rules """ test.md:3:13:IBMQuantum.Terms:Use 'end' or 'last' rather than 'bottom' test.md:5:11:IBMQuantum.Terms:Use 'several' rather than 'a number of' - test.md:7:9:IBMQuantum.Terms:Use 'complete' or 'perform' rather than 'do' test.md:11:10:IBMQuantum.Spelling:Unknown word 'algorihm'; fix or add to dictionary. test.md:15:24:IBMQuantum.Terms:Use 'following' rather than 'below' test.md:19:29:IBMQuantum.However:Double-check your punctuation around 'however' (see github.com/IBM/ibm-quantum-style-guide/issues/10 for more information). diff --git a/fixtures/Other/test.md b/fixtures/Other/test.md new file mode 100644 index 0000000..9204773 --- /dev/null +++ b/fixtures/Other/test.md @@ -0,0 +1 @@ +This is a sentence with a non-contracted word.