git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Leila <muhtasib@gmail.com>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: git@vger.kernel.org, Thomas Rast <trast@student.ethz.ch>,
	konglu@minatec.inpg.fr
Subject: Re: [PATCH/RFC] Documenation update: use of braces in if/else if/else chain
Date: Sun, 10 Jun 2012 16:52:18 -0400	[thread overview]
Message-ID: <CAA3EhHLepTC2WThDvAWk5WPcMPQapqo=D7KhpdCESy9D9JO4vg@mail.gmail.com> (raw)
In-Reply-To: <20120610202205.GA2052@burratino>

On Sun, Jun 10, 2012 at 4:22 PM, Jonathan Nieder <jrnieder@gmail.com> wrote:
> Also true.  But:
>
>        /* correct */
>        if (bla) {
>                x = 1;
>                ...
>        } else
>                x = 2;
>

According to a discussion on my patch, this was cited (not in ref to my code):
Junio C Hamano <gitster@pobox.com> a écrit :

Two points on style (also appear elsewhere in this patch):

       if (!"applying") {
               ...
       } else {
               state->rebase_in_progress = 1;
       }

 - "else" comes on the same line as closing "}" of its "if" block;

 - if one of if/else if/else chain has multiple statement block, use {}
  even for a single statement block in the chain.


So I opened this documentation patch to gain consensus around this
issue, and update the docs accordingly. Depending on the agreement
reached, I can modify the wording of the patch. I don't need to site
the linux Kernel part, I can just say what is supported in this
project.


I think we should still keep this part of the patch:

+    And "else"
+   should come on the same line as the closing "}" of its "if" block.


> And:
>
> If you have a long "if" with a one-line "else", consider whether you
> are needlessly keeping the reader in suspense about something simple.
> It might be more pleasant to read with the exceptional case up front:
>
>        if (!bla) {
>                x = 2;
>        } else {
>                x = 1;
>                ...
>        }
>
> This is especially true when the exceptional case returns or exits.
>
>        if (bla && no_bla)
>                return error("--blah and --no-blah cannot be used together");
>        x = 1;
>        ...

Agreed!

Thanks,
Leila

      reply	other threads:[~2012-06-10 20:52 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-10 17:26 [PATCH/RFC] Documenation update: use of braces in if/else if/else chain Leila Muhtasib
2012-06-10 20:22 ` Jonathan Nieder
2012-06-10 20:52   ` Leila [this message]

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='CAA3EhHLepTC2WThDvAWk5WPcMPQapqo=D7KhpdCESy9D9JO4vg@mail.gmail.com' \
    --to=muhtasib@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=jrnieder@gmail.com \
    --cc=konglu@minatec.inpg.fr \
    --cc=trast@student.ethz.ch \
    /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).