Modify ↓
Ticket #11532 (closed feature: notabug)
Document jQuery.Tween
| Reported by: | SineSwiper | Owned by: | gnarf |
|---|---|---|---|
| Priority: | low | Milestone: | 1.8 |
| Component: | effects | Version: | 1.7.2 |
| Keywords: | Cc: | ||
| Blocking: | Blocked by: |
Description
Within the animate() documentation, the Step Function docs mention the "jQuery.fx prototype", but there is no separate reference to the specifications of the prototype. It mentions a few properties, but there should be a separate page for the prototype. The jQuery.fx prototype is also mentioned in cssHooks.
Properties and methods for jQuery.fx include:
update cur custom show hide step elem start end now pos unit tick prop options startTime speeds etc.
Change History
comment:1 Changed 14 months ago by dmethvin
- Priority changed from undecided to low
- Status changed from new to open
- Type changed from bug to enhancement
- Component changed from unfiled to effects
- Milestone changed from None to 1.8
comment:2 Changed 13 months ago by gnarf
This will be docs for jQuery.Tween objects anyway in 1.8 :)
comment:3 Changed 12 months ago by timmywil
- Owner set to gnarf
- Status changed from open to assigned
- Summary changed from No documentation for the jQuery.fx prototype to Document jQuery.Tween
Please follow the bug reporting guidlines and use jsFiddle when providing test cases and demonstrations instead of pasting the code in the ticket.
Note: See
TracTickets for help on using
tickets.

I don't think we *want* to document everything and should be very careful about documenting things that prevent further optimization or implementation changes down the road. There definitely is a subset that deserves a few words, but since gnarf is planning to do some changes for 1.8 it should probably wait until then.