Re: [PATCH v10 05/13] ref-filter: implement an `align` atom

[Eric Sunshine <sunshine@sunshineco.com>]

On Sun, Aug 9, 2015 at 10:11 AM, Karthik Nayak <karthik.188@gmail.com> wrote:
> Implement an `align` atom which left-, middle-, or right-aligns the
> content between %(align:..) and %(end).
>
> Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
> ---
> diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
> index e49d578..d949812 100644
> --- a/Documentation/git-for-each-ref.txt
> +++ b/Documentation/git-for-each-ref.txt
> @@ -127,6 +127,15 @@ color::
>         Change output color.  Followed by `:<colorname>`, where names
>         are described in `color.branch.*`.
>
> +align::
> +       Implement an `align` atom which left-, middle-, or
> +       right-aligns the content between %(align:..)  and

This documentation seems to be copied a bit too literally from the
commit message. Saying "Implement an `align` atom" makes sense for the
commit message, but not for the documentation of the 'align' atom.
Instead,

    Left-, middle-, or right-align the content between
    %(align:...) and %(end).

would sound better.

> +       %(end). Followed by `:<position>,<width>`, where the
> +       `<position>` is either left, right or middle and `<width>` is
> +       the total length of the content with alignment. If the
> +       contents length is more than the width then no alignment is
> +       performed. Currently nested alignment is not supported.