WordPress.org
Get WordPress

Make WordPress Core

Opened 9 years ago

Closed 9 years ago

Last modified 8 years ago

#42675 closed enhancement (fixed)

Add documentation for heartbeat.js

Reported by: andizer Owned by: adamsilverstein
Priority: normal Milestone: 5.1
Component: General Version:
Severity: normal Keywords:
Cc: Focuses: javascript, docs

Description

Added documentation for wp-includes/js/heartbeat.js
Please give props to ​andizer, ​jjcomack and ​CarolineGeven

Attachments (2)

heartbeat.diff​ (18.6 KB ) - added by andizer 9 years ago.
heartbeat-2.diff​ (18.6 KB ) - added by andizer 9 years ago.
This time the diff has been done correctly.

Download all attachments as: .zip

Change History (7)

@andizer
9 years ago

@andizer
9 years ago

This time the diff has been done correctly.

#1 @netweb
9 years ago

  • Milestone Awaiting Review → 5.0

#2 @adamsilverstein
9 years ago

  • Owner set to adamsilverstein
  • Status new → assigned

This ticket was mentioned in ​Slack in #core-committers by atimmer. ​View the logs.
9 years ago

#4 @atimmer
9 years ago

  • Resolution → fixed
  • Status assigned → closed

In 42389:

Docs: Improve JS Docs for wp-includes/js/heartbeat.js.

Most of the documentation was already present. This change achieves the following:

  • Fixes the formatting for most doc blocks.
  • Adds @since tags to all functions.
  • Makes sure the heartbeat public methods are correctly added to the wp.heartbeat namespace.

Props andizer, jjcomack, carolinegeven.
Fixes #42675.

#5 @johnbillion
8 years ago

  • Milestone 5.0 → 5.1
  • Version trunk
Note: See TracTickets for help on using tickets.