Fix incorrect return types in timeline and statuses filter documentation#295
Merged
Fix incorrect return types in timeline and statuses filter documentation#295
Conversation
The timeline filters (mastodon_api_timelines, mastodon_api_tag_timeline, mastodon_api_public_timeline) and the mastodon_api_statuses filter were documented as returning Entity\Status[] but actually return WP_REST_Response via the get_posts() method. Also adds a missing docblock to get_posts(), fills in empty code examples, and fixes a "simeline" typo.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mastodon_api_timelines,mastodon_api_tag_timeline,mastodon_api_public_timeline, andmastodon_api_statusesfilter docblocks: they documentedEntity\Status[]/array|nullas param/return types but the handlers returnWP_REST_Responseviaget_posts()Handler::get_posts()methodExample:blocksapi_public_timelinedocblockTest plan