WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#41602 closed defect (bug) (fixed)

Improved JS documentation of audiovideo.manifest.js

Reported by: nicollle Owned by: adamsilverstein
Milestone: 4.9 Priority: normal
Severity: normal Version: 4.9
Component: Media Keywords: has-patch
Focuses: javascript, docs Cc:

Description

Improved JavaScript documentation of the file audiovideo.manifest.js according to the WordPress development guidelines.
This work was done in collaboration with @manuelaugustin.

Attachments (3)

audiovideo-manifest.diff (3.7 KB) - added by nicollle 3 years ago.
Added JS documentation of audiovideo.manifast.js
41602.diff (4.1 KB) - added by adamsilverstein 3 years ago.
slight spacing cleanup, add some periods
41602.2.diff (3.9 KB) - added by afercia 3 years ago.

Download all attachments as: .zip

Change History (9)

@nicollle
3 years ago

Added JS documentation of audiovideo.manifast.js

@adamsilverstein
3 years ago

slight spacing cleanup, add some periods

#2 @adamsilverstein
3 years ago

  • Owner set to adamsilverstein
  • Resolution set to fixed
  • Status changed from new to closed

In 41239:

Docs: Improve JavaScript documentation in audiovideo.manifest.js.

Add and improve JSDOC blocks.

Props nicollle, manuelaugustin.
Fixes #41602.

#3 @adamsilverstein
3 years ago

  • Milestone changed from Awaiting Review to 4.9

#4 @afercia
3 years ago

  • Keywords needs-patch added; has-patch removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

I guess the doc improvements introduced here should also be applied to the compiled files, running grunt watch/browserify. Right now, when running grunt precommit, media-audiovideo.js gets modified.

@afercia
3 years ago

#5 @afercia
3 years ago

  • Keywords has-patch added; needs-patch removed

41602.2.diff adds the changes to the generated media-audiovideo.js file.

#6 @afercia
3 years ago

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

In 41330:

Docs: Update media-audiovideo.js after [41239].

Fixes #41602.

Note: See TracTickets for help on using tickets.