#41509 closed enhancement (fixed)
Remove references to since MU
Reported by: | spacedmonkey | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 4.9 | Priority: | normal |
Severity: | normal | Version: | 3.0 |
Component: | Networks and Sites | Keywords: | good-first-bug has-patch |
Focuses: | docs, multisite | Cc: |
Description
Searching the code there are 168 references to since MU
. This is confusing if you do not know the history of multisite and it's merge into core. These docs should be changed to reflect the core versioning numbers, which is since 3.0.0
Attachments (1)
Change History (14)
This ticket was mentioned in Slack in #core-multisite by danhgilmore. View the logs.
8 years ago
#4
@
8 years ago
I believe the reason @since MU
was used is just that, it indicates there is history prior to the 3.0 merge.
I'd favour a syntax such as @since MU (3.0.0)
if it helps newcomers.
#5
@
8 years ago
@spacedmonkey @desrosj @johnbillion The format suggested by @johnbillion make sense. I have created a patch file with the changes. There are 168 matches across 17 files.
#7
follow-up:
↓ 8
@
8 years ago
How about @since 3.0.0 (MU)
? The key thing is WordPress version is more important at this point.
#8
in reply to:
↑ 7
@
8 years ago
- Milestone changed from Awaiting Review to 4.9
Replying to spacedmonkey:
How about
@since 3.0.0 (MU)
? The key thing is WordPress version is more important at this point.
I prefer the @since MU (3.0.0)
version because it still (correctly) documents that the code was sourced from MU, then uses 3.0.0 to provide context.
#9
@
8 years ago
- Owner set to DrewAPicture
- Resolution set to fixed
- Status changed from new to closed
In 41200:
#10
follow-up:
↓ 11
@
8 years ago
@DrewAPicture Does this require a change on DevHub (https://developer.wordpress.org/reference/since/MU/)?
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#miscellaneous needs also an update.
#11
in reply to:
↑ 10
@
8 years ago
Replying to ocean90:
@DrewAPicture Does this require a change on DevHub (https://developer.wordpress.org/reference/since/MU/)?
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#miscellaneous needs also an update.
Yeah, working on an exception for the parser so they still map to mu. I'll update the standards today.
There is something nice about knowing something was built (and has a history of its own) before the merge. I've used that as an indicator in the past that I may need to hunt through https://mu.trac.wordpress.org/ for answers. That said, if you blame back to the merge changeset, then you'll probably know you can go further.
Do we lose anything by changing them all to 3.0.0?