search

openSUSE / suse-vale-styleguide

Humble style guide for technical writers by a technical writer
GNU General Public License v3.0
23 stars 5 forks source link

Create SentenceLength.yml #95

Closed alexvonme closed 5 months ago

alexvonme commented 5 months ago

I added a rule to check for how many words there are in each sentence.

ccoVeille commented 5 months ago

You could use this

https://github.com/errata-ai/readability/blob/main/Readability%2FGunningFog.yml#L5-L8

Formula:words Condition > 20

tbazant commented 5 months ago

I added a rule to check for how many words there are in each sentence.

@alexvonme please update your code to what @ccoVeille suggests

alexvonme commented 5 months ago

@ccoVeille Is there a particular reason why you suggest using the Gunning Fog formula over the others in the Readability folder?

ccoVeille commented 5 months ago

absolutely none, I found one with a formula that mentioned the number of words and shared the first one

extends: metric
message: "Try to keep your sentence short: %s words (less than 20 is recommended)."

formula: |
  words

condition: "> 20"

:point_up: this is pseudo-code of course

alexvonme commented 5 months ago

In that case, please allow me some time to deliberate on the issue. I'd rather be thorough and test a few configurations before we continue.

alexvonme commented 5 months ago

Let's freeze this one until the upstream SUSE/doc-styleguide#299 is resolved. We can make the relevant changes based on the outcome of that.

alexvonme commented 5 months ago

This pull request is now moved to #102.