Skip to content

Explicitly describe $ as an alias for jQuery #681

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

AurelioDeRosa
Copy link
Member

Fixes gh-680

@@ -53,6 +53,8 @@ $( document ).ready(function() {
});
```

<div class="warning">**Note**: The jQuery library exposes its methods and properties via two properties of the <code>window</code> object called <code>jQuery</code> and <code>$</code>. <code>$</code> is simply an alias for <code>jQuery</code> and it's often employed because it's shorter and faster to write.</div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should this be in a class="warning" box? Might as well just have a normal paragraph about this. The warnings always give me the feeling something is a gotcha or something could go wrong, but in this case it's just a concept being introduced.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it doesn't flow well with the rest of the discussion which has another focus, so I put it in a "aside" bar.

@AurelioDeRosa
Copy link
Member Author

@agcolom should I merge it or should I address the comment of @arthurvr? I think it's fine as is but happy to update the PR:

@agcolom
Copy link
Member

agcolom commented Oct 29, 2015

@AurelioDeRosa We could use either a normal note or a div class="note" which gives a blue box if I remember correctly.

@AurelioDeRosa
Copy link
Member Author

@agcolom This is more of a general comment but I've checked the note class and it doesn't look very readable. I think the contrast isn't enough especially for <code>.

@agcolom
Copy link
Member

agcolom commented Jan 21, 2016

@AurelioDeRosa I think you can land your PR :-)

@AurelioDeRosa
Copy link
Member Author

Thank you for the review @agcolom. I'm going to merge it now.

@AurelioDeRosa AurelioDeRosa deleted the jquery-alias branch January 21, 2016 22:08
Krinkle pushed a commit that referenced this pull request Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants