Re: [PATCH] make slash-rules more readable

From: Philip Oakley <philipoakley@iee.org>
Date: May 18, 2019, 19:34 UTC
Message-ID: <7b062fd1-c793-b8b9-c997-90f53f958e2c@iee.org>
In-Reply-To: <20190518140759.14500-1-admin@in-ici.net>

Hi Adam

On 18/05/2019 15:07, Dr. Adam Nielsen wrote:

Show 5 quoted lines

> + - If the pattern contains no slash or only a trailing slash,
> +   the pattern is matched against all files and folders (recursively)
> +   from the location of the `.gitignore` file.
> +   For example, `frotz/` matches `frotz` and `a/frotz` that
> +   is a directory (relative from the `.gitignore` file).

This "Otherwise" below could be the complement to the initial "If", or could be part of a "matches" pair of example sentences. At least on my initial reading I paired it via the 'matches'.

A blank line separator make make it more obvious. Alternatively, make the "For example" parts flow as part of their previous lines. If you go for an additional blank line then the next next para needs to clarify it's 'above' as their will be two paras, not one.

> +   Otherwise the pattern is matched relative to the
> +   location of the `.gitignore` file.
> +   For example, `doc/frotz/` matches `doc/frotz` directory, but not
> +   `a/doc/frotz` (relative from the `.gitignore` file).

 > + - The above pargraph also includes the case of a leading slash.

s/pargraph/paragraph/ -- Philip