#5017 closed enhancement (fixed)
Suggestion: move Explanation section higher up on DevHub pages
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | Priority: | normal | |
Component: | Developer Hub | Keywords: | 2nd-opinion |
Cc: |
Description
Most of the time the Explanation (frontend: More Information) section is used to provide Usage examples.
I believe this should be higher up, before Source, Changelog etc., so right underneath Parameter and Return.
Change History (12)
This ticket was mentioned in Slack in #docs by valentinbora. View the logs.
5 years ago
This ticket was mentioned in Slack in #meta by valentinbora. View the logs.
5 years ago
#7
@
4 years ago
@coffee2code
Thank you so much! Your change made whole document useful and better than before!
#8
@
4 years ago
The change for this ticket does not match the stated change. It says to move the More Information only, but what happened was the Source and Changelog were moved down the page, instead of just moving the Information up.
I find it very confusing now to see Related before the Source.
The Source needs to be close to the Parameters, so there is not so much scrolling back and forth.
Perhaps the More Information should be first.
But Related makes no sense before the Source.
This ticket was mentioned in Slack in #docs by joyously. View the logs.
4 years ago
#10
@
4 years ago
@coffee2code
I agree what @joyously says. Related section is not so useful and too long than Source section.
How about moving Source section immediately after More Information section?
fyi. please refer below two types
No More Information:
https://developer.wordpress.org/reference/functions/get_the_title/
With More Information:
https://developer.wordpress.org/reference/functions/get_next_posts_link/
This is important suggestion.
Ideally we should enhance the inline docs of functions or classes but header area is limited and not appropriate for long description and/or usage. We should move Explanation section higher as @valentinbora suggests (or, in ohter words, immediately after the returns.)