Skip to content

Document package.rule = NO #86

@mschrumpf

Description

@mschrumpf

Check for existing issues

  • Completed

Describe the feature

I have searched the Vale documentation for instructions how to ignore individual rules from a package / style and I have not been able to anything.
A fellow technical writer told me that you can do this by adding package.rule = NO in .vale.ini.
I added the following to my .vale.ini:

Microsoft.DateFormat = NO
Microsoft.Contractions = NO
Microsoft.Quotes = NO

And sure enough, those three rules are being ignored now. That's great. But why isn't this documented anywhere? Or if it is, why am I having such a hard time finding it?

I am just getting started with using Vale. To me, the most sensible workflow of using Vale seems to be the following:

  • use the official packages
  • drop/ignore the rules you don't need
  • substitute them with your own

I have encountered great difficulties with arriving at this workflow due to the issue described above.
I would be very happy if this function or any alternative methods for the workflow could be featured more prominently in the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions