search

errata-ai / Google

A Vale-compatible implementation of the Google Developer Documentation Style Guide.
MIT License
69 stars 23 forks source link

Capitalisation rule and possesive #5

Closed tomato42 closed 4 years ago

tomato42 commented 4 years ago

I have a heading with a possessive form that uses an apostrophe.

The literal header in rst file is:

Client's key share and finish
-----------------------------

it's getting marked by the HeadingPunctuation rule: https://github.com/errata-ai/Google/blob/master/Google/HeadingPunctuation.yml

Shouldn't apostrophes be allowed in headings?

jdkato commented 4 years ago

Yes, this is a bug -- I've added a test that reproduces the issue and I'll look into fixing it soon.

jdkato commented 4 years ago

This will be fixed in the next release of Vale -- I'll close the issue once the release is available.