Update ExampleHelper.md to use const#7256
Open
itsalaidbacklife wants to merge 1 commit intobalderdashy:masterfrom
Open
Update ExampleHelper.md to use const#7256itsalaidbacklife wants to merge 1 commit intobalderdashy:masterfrom
const#7256itsalaidbacklife wants to merge 1 commit intobalderdashy:masterfrom
Conversation
The sails docs use `var` in most example code. This is an outdated practice as the newer alternatives of `let` and `const` offer more granular control over variable scoping in a way that is preferable 95+% of the time. The use of `var` in the docs gives new users the impression that sails is dated. Updating the docs to use `const` or occasionally `let` in the examples will make sails more appealing. I'm opening this PR as a one-off for a single page in the hopes of getting feedback on whether the sails team agrees that this change is appropriate before I more holistically propose changes to a broader range of sails docs to update them similarly.
|
Thanks for submitting this pull request, @itsalaidbacklife! We'll look at it ASAP. In the mean time, here are some ways you can help speed things along:
Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, disclose it responsibly. For help with questions about Sails, click here. |
neonexus
approved these changes
Oct 16, 2022
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The sails docs use
varin most example code. This is an outdated practice as the newer alternatives ofletandconstoffer more granular control over variable scoping in a way that is preferable 95+% of the time. The use ofvarin the docs gives new users the impression that sails is dated. Updating the docs to useconstor occasionallyletin the examples will make sails more appealing.I'm opening this PR as a one-off for a single page in the hopes of getting feedback on whether the sails team agrees that this change is appropriate before I more holistically propose changes to a broader range of sails docs to update them similarly.