#653 closed defect (bug) (fixed)
Add changelog support to the Code Reference
Reported by: | DrewAPicture | Owned by: | coffee2code |
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | Developer Hub | Keywords: | has-patch |
Cc: |
Description
For several versions now, we've been leveraging the use of multiple @since
tags with various functions, methods, and hooks in core.
This feature is already supported by phpDocumentor, recommended even, and would allow us to provide a changelog view on Code Reference item templates.
I've submitted a pull request to the parser to allow for multiple @since
tags for a single item that also recognizes @since
descriptions.
Attached here is a patch to bring changelog support into the wporg-developer theme that marries with the parser changes.
Attachments (3)
Change History (8)
#2
in reply to:
↑ 1
@
10 years ago
Replying to atimmer:
I think I would prefer it would simply show "Since: 3.1.0" if it has only 1 entry. Now it looks a little bit weird when you have this title "Changelog" with only one list item.
I disagree. I think it's important to convey that this information is part of the "changelog" even if there's only one entry.
We don't necessarily have to use bullets, we could use a table like php.net, but either way, it needs to be consistent across the board as these changelogs will be showing up on references of all four types.
This also doesn't cover the fact that we're basically the only project I can find that lists changes ordered by oldest to newest. But that may be a discussion for another day.
#3
@
10 years ago
- Owner set to coffee2code
- Resolution set to fixed
- Status changed from new to closed
In 938:
I think I would prefer it would simply show "Since: 3.1.0" if it has only 1 entry. Now it looks a little bit weird when you have this title "Changelog" with only one list item.