WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 2 years ago

Last modified 20 months ago

#42675 closed enhancement (fixed)

Add documentation for heartbeat.js

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

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 3 years ago.
heartbeat-2.diff (18.6 KB) - added by andizer 3 years ago.
This time the diff has been done correctly.

Download all attachments as: .zip

Change History (7)

@andizer
3 years ago

@andizer
3 years ago

This time the diff has been done correctly.

#1 @netweb
3 years ago

  • Milestone changed from Awaiting Review to 5.0

#2 @adamsilverstein
3 years ago

  • Owner set to adamsilverstein
  • Status changed from new to assigned

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


2 years ago

#4 @atimmer
2 years ago

  • Resolution set to fixed
  • Status changed from assigned to 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
20 months ago

  • Milestone changed from 5.0 to 5.1
  • Version trunk deleted
Note: See TracTickets for help on using tickets.