jQuery() (no arguments) description is ambiguous #232

Closed
ajpiano opened this Issue Jan 23, 2013 · 5 comments

Comments

Projects
None yet
5 participants
Member

ajpiano commented Jan 23, 2013

http://api.jquery.com/jQuery/

jQuery()

This method does not accept any arguments.

This is confusing, because the method does accept arguments, as in the 5 signatures above it. The docs go on later to explain that jQuery() is used to supply an empty jQuery collection, but the descriptoin is still unintuitive. I do believe the "This method does not accept any arguments" is happening automatically, as a result of there...being no arguments in the xml

Contributor

pobocks commented Jan 23, 2013

It is - it's done in the XSLT

It's really describing the specific function signature - I think the "This
Method does not accept any arguments" phrasing is just the best I could
come up with at the time.

On Wed, Jan 23, 2013 at 12:27 PM, adam j. sontag
notifications@github.comwrote:

http://api.jquery.com/jQuery/

jQuery()
This method does not accept any arguments.

This is confusing, because the method does accept arguments, as in the
5 signatures above it. The docs go on later to explain that jQuery() is
used to supply an empty jQuery collection, but the descriptoin is still
unintuitive. I do believe the "This method does not accept any arguments"
is happening automatically, as a result of there...being no arguments in
the xml


Reply to this email directly or view it on GitHubhttps://github.com/jquery/api.jquery.com/issues/232.

Member

ajpiano commented Jan 23, 2013

Right on - so I think we should special-case it for this jQuery() version to say "Creates an empty jQuery object" (if we can)

Member

arthurvr commented Jan 6, 2015

so I think we should special-case it for this jQuery() version to say "Creates an empty jQuery object" (if we can)

So then we need to figure it out. Can we?

Owner

dmethvin commented Jan 7, 2015

I don't see the text "This method does not accept any arguments" in the current page, does still need to be fixed?

Member

arthurvr commented Jan 7, 2015

Now there only is "This signature does not accept any arguments.", which is correct. Let's close this issue.

dmethvin closed this Jan 7, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment