WordPress.org
Get WordPress

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#59666 closed defect (bug) (fixed)

Improve meta revision documentation from 6.4

Reported by: jeremyfelt Owned by: SergeyBiryukov
Priority: normal Milestone: 6.4
Component: Revisions Version: 6.4
Severity: normal Keywords: has-patch commit dev-reviewed
Cc: Focuses: docs

Description

I made a few documentation changes while reviewing the new meta revisions code in trunk and am obstinate enough to try and include them in 6.4 rather than wait for #59651.

  • Fix the position on @since 6.4.0 in a few places
  • Adjust parameter spacing
  • Add missing @return documentation

Happy to move the PR over to that ticket if necessary. :)

Change History (9)

This ticket was mentioned in ​PR #5520 on ​WordPress/wordpress-develop by ​@jeremyfelt.
3 years ago #1

I made a few documentation tweaks to meet WP doc standards while reviewing the meta revisions code.

  • Fix the position on @since 6.4.0 in a few places
  • Adjust parameter spacing
  • Add missing @return documentation

Trac ticket: https://core.trac.wordpress.org/ticket/59666

#2 @SergeyBiryukov
3 years ago

  • Keywords commit added
  • Milestone Awaiting Review → 6.4

Looks good, thanks!

#3 @mukesh27
3 years ago

Good catch, introduced in [56714] / #20564.

#4 @SergeyBiryukov
3 years ago

  • Owner set to SergeyBiryukov
  • Resolution → fixed
  • Status new → closed

In 56984:

Docs: Improve documentation for meta revision functions.

Includes:

  • Correcting the position of @since 6.4.0 in a few places.
  • Adding missing @return documentation.
  • Adjusting parameter spacing.

Follow-up to [56714].

Props jeremyfelt, mukesh27.
Fixes #59666.

​@SergeyBiryukov commented on ​PR #5520:
3 years ago #5

Thanks for the PR! Merged in r56984.

#6 @SergeyBiryukov
3 years ago

  • Keywords dev-feedback added
  • Resolution fixed
  • Status closed → reopened

Reopening for backporting to the 6.4 branch after a second committer's review.

​@adamsilverstein commented on ​PR #5520:
3 years ago #7

Thanks @jeremyfelt! I had a stalled PR with some of these as I had noticed them as well on later review. Appreciate you hopping in to fix.

#8 @jorbin
3 years ago

  • Keywords dev-reviewed added; dev-feedback removed

These changes look good for 6.4 as they don't touch strings nor impact behavior in any way. I'm going to backport now.

#9 @jorbin
3 years ago

  • Resolution → fixed
  • Status reopened → closed

In 56989:

Docs: Improve documentation for meta revision functions.

Backports [56984] to 6.4 branch.

Includes:

  • Correcting the position of @since 6.4.0 in a few places.
  • Adding missing @return documentation.
  • Adjusting parameter spacing.
  • Follow-up to [56714].

Props jeremyfelt, mukesh27, SergeyBiryukov.
Fixes #59666.

Note: See TracTickets for help on using tickets.