Description

asottile

opened on Dec 1, 2014

Issue body actions

The documentation could use with more links to some examples. (Adding issue on behalf of @ivanlei)

Activity

1. philipmulcahy commented on May 9, 2016

   

   philipmulcahy

   on May 9, 2016

   More actions

   The section starting with "Adding pre-commit plugins to your project" is pretty unclear.
   Maybe it could be worded differently and show usage of more/most of the "keywords"?

   s/The pre-commit config file describes:/The following directives/options control which hooks are applied to your project and how they behave:/

   Also, the table should clarify at what level in the file the different words are relevant - for example "sha" applies one level higher than "id" - you could either split the table into two groups, one for the top level (per repo) and one for the lower level (per hook). I reckon a BNF for the config file format is overkill, but the current setup is not clear enough.
2. asottile commented on Oct 4, 2017

   

   asottile

   on Oct 4, 2017

   MemberAuthor

   More actions

   @philipmulcahy (yes, I'm very late to the party) separating out repo / sha just happened in #138 so now it's a little more obvious (I hope!)

   Reacted by Ülgen Sarıkavak

Issue actions