Docs: Code conventions improvements #6313
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
LGTM |
|
By analyzing the blame information on this pull request, we identified @nzakas to be a potential reviewer |
| * See LICENSE file in root directory for full license. | ||
| */ | ||
| ``` | ||
| The `@author` field gives you credit for having created the file. There is no need to assert copyright on individual files. |
There was a problem hiding this comment.
Could use some help here on whether I should mention the jQuery license, or just remove the sentence about copyright altogether, or something else. Thanks!
|
LGTM |
|
Just one small note. This doc was copied from my book and was focused on web deployments, that's why strict mode was the reverse of what we do. I guess further proof that no one reads this doc. :) |
|
@nzakas Even if nobody else reads the doc, I do! 😄 I will make your suggested change and push tonight. |
|
LGTM |
|
@nzakas Should be good to go now. Thanks for your patience. |
|
Lgtm |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Highlights:
File Overview
I removed everything to do with copyright from that section. Now that we are in the jQuery foundation, we have decided to just use the "author" field and no copyright or license.
Strict Mode
Our repository enforces global "strict", but the code conventions imply that we should have "strict" mode in functions.
My assumption is that those conventions have more to do with non-module code, whereas NodeJS actually has an extra scope, global return, etc. and so it is safe to have "use strict" globally (and possibly better, since it means we don't have sections of files that are not strict).
Other
Whitespace notes were slightly ambiguous about the spacing between elements of the for loop initialization. I added a note specifying that whitespace should only be after semicolons, not before.
(Apologies to @nzakas for creating a branch on the main repo-- I was using the GitHub editor and apparently did something wrong. Hopefully I'll figure it out before I do another GitHub doc change.)