[RFC|Accepted] Coding Guideline Modifications

[callumacrae]

Well yeah, they're parentheses to mark an object, not a block of code. Objects always want the parentheses on the same line, as this wouldn't make sense:

Code: Select all

fn(
{
    a: 'foo',
    b:
    {
        c: 'bar'
    }
})

[wGEric]

Well yeah, they're parentheses to mark an object, not a block of code. Objects always want the parentheses on the same line, as this wouldn't make sense:

Code: Select all

fn(
{
    a: 'foo',
    b:
    {
        c: 'bar'
    }
})

Objects don't always want the curly brackets on the same line. Your code is valid and you will get the result that you expect. Are you proposing to put the curly bracket on the same line for objects?

Here is some test code:

Code: Select all

<script>
var test =
   {
      a: 'foo',
      b:
      {
         c: 'bar'
      }
   };
   
console.log(test);

var fn = function() {
   return
   {
      a: 'foo'
   }
};

console.log(fn()); // undefined
</script>

[callumacrae]

Definitely, or it looks stupid.

[Oleg]

Having read some diffs recently I am now firmly in the camp of always specifying @return. Without @return I am never sure if the function returns nothing or the return value is undocumented, and I end up scouring the code to find out, which defeats the purpose of having documentation.

[Oleg]

How about requiring all sentences in commit messages to begin with a capital letter (unless the first word is a variable or otherwise something that normally begins with lowercase)?

[A_Jelly_Doughnut]

Seems a little pedantic to me?

[naderman]

Indeed, I think it's common sense to use proper capitalisation, and if there's an occasional exception that's ok, too.

[callumacrae]

How about requiring all sentences in commit messages to begin with a capital letter (unless the first word is a variable or otherwise something that normally begins with lowercase)?

I've always worked with first letter capital and ending with a full stop wherever possible.

[imkingdavid]

How about requiring all sentences in commit messages to begin with a capital letter (unless the first word is a variable or otherwise something that normally begins with lowercase)?

I've always worked with first letter capital and ending with a full stop wherever possible.

I suppose that requiring proper English grammar is a good idea for uniformity, although sometimes I have used a lowercase letter in the summary (e.g. [branch] fixed X error in Y.php) since that didn't look too bad. The purpose of the hard stop and capital letter is to indicate the end of one sentence and the beginning of another. However, in a summary like the one able, neither is needed, imo, since there is only the one sentence.

[Oleg]

I don't care for capitalization that strongly. I do however think that we should document that we don't require any particular capitalization if this is what is decided, or possibly that we suggest proper capitalization but do not require it.