docs: Mark Helper::convert_wp_object as API method #3005
+2
−2
Conversation
This file contains 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
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.
Related:
convert_wp_objectmethod #3004Issue
Timber\Helper::convert_wp_objectis not listed as an API functionSolution
Mark as API function and rebuild docs.
Impact
More functions documentated
Usage Changes
No
Considerations
When taking a look at the Helper methods, they are sparsely documented. We could improve on that.
When trying to commit,
Rectorwas being a pain in the butt since it wanted to remove the mixed parameters from methods, including our API functions.@nlemoine , could we remove that conversion like so? I can make a separate PR for that. This would make the life of of other contributors a lot easier.
Testing
already tested