git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] doc: reformat the paragraph containing the 'cut-line'
Date: Tue, 18 Jul 2017 19:59:28 +0530	[thread overview]
Message-ID: <1500388168.2065.2.camel@gmail.com> (raw)
In-Reply-To: <xmqqefteg155.fsf@gitster.mtv.corp.google.com>

On Mon, 2017-07-17 at 15:16 -0700, Junio C Hamano wrote:
> Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:
> > +	Same as `whitespace` except that everything from (and including)
> > +    the line found below is truncated, if the message is to be edited.
> > +    "`#`" can be customized with core.commentChar.
> 
> Is there some funny indentation setting involved?  Why aren't these
> lines aligning? 
> 
Yep, there was an indentation issue that I have fixed now.

> > +
> > +        # ------------------------ >8 ------------------------
> > +
> 
> 
> Does an empty line before this one screw up the asciidoc formatting?
> 
I think *no*. I build the docs with the change and didn't find anything
odd. 

> If the long line is problematic, I think it is safer to perhaps
> spell it out, perhaps something like
> 
> 	... except that everything is ignored down from the
> 	"scissors" line that begins with a core.commentChar (`#` by
> 	default) followed by many dashes `-`, followed by the
> 	scissors mark ` >8 `, followed by many dashes `-`.
> 
> ???
> 
I think it's better to keep the line as it is, considering the famous
cliché, "a picture is worth a thousand words" and combining it with the
fact that "humans looks for patterns in everything".

Spelling the line out would make it hard to get a *picture* of what's
trying to be described.

-- 
Kaartic

  reply	other threads:[~2017-07-18 14:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-17 15:38 [PATCH] doc: reformat the paragraph containing the 'cut-line' Kaartic Sivaraam
2017-07-17 22:16 ` Junio C Hamano
2017-07-18 14:29   ` Kaartic Sivaraam [this message]
2017-07-18 14:34     ` Kaartic Sivaraam

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1500388168.2065.2.camel@gmail.com \
    --to=kaarticsivaraam91196@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).