Bug Tracker

Modify

Ticket #8471 (closed bug: fixed)

Opened 2 years ago

Last modified 15 months ago

Documentation for end() shouldn't use the word 'closure' in the literary sense

Reported by: yahelc@… Owned by: addyosmani
Priority: low Milestone: 1.next
Component: unfiled Version: 1.5.1
Keywords: Cc:
Blocking: Blocked by:

Description

When talking about using end() at the end of a chain of end() calls, the documentation states:

The last end() is unnecessary, as we are discarding the jQuery object immediately thereafter. However, when the code is written in this form, the end() provides visual symmetry and closure—making the program, at least to the eyes of some developers, more readable.

The word 'closure' is fairly loaded in JavaScript and jQuery in particular for its technical meaning, and it may confuse people to say that this use provides 'closure'.

Change History

comment:1 Changed 2 years ago by addyosmani

  • Owner set to addyosmani
  • Priority changed from undecided to low
  • Status changed from new to assigned

I think the probability of the word 'closure' in this case being misinterpreted is fairly low given it's placement in the sentence, but we'll consider revising the language of the docs and update if needed.

comment:2 Changed 2 years ago by addyosmani

  • Status changed from assigned to closed
  • Resolution set to fixed

We've updated this here: http://bugs.jquery.com/ticket/8471

Please follow the  bug reporting guidlines and use  jsFiddle when providing test cases and demonstrations instead of pasting the code in the ticket.

View

Add a comment

Modify Ticket

Action
as closed
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.