Skip to content

Trac 61648, Updates docblocks.#7509

Closed
kebbet wants to merge 6 commits intoWordPress:trunkfrom
kebbet:61648-docs
Closed

Trac 61648, Updates docblocks.#7509
kebbet wants to merge 6 commits intoWordPress:trunkfrom
kebbet:61648-docs

Conversation

@kebbet
Copy link
Copy Markdown

@kebbet kebbet commented Oct 5, 2024

https://core.trac.wordpress.org/ticket/61648

Not sure about the line 32 * @throws ImagickException, it should possibly move to the media function.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 5, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props kebbet, peterwilsoncc, apermo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 5, 2024

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Copy Markdown

@apermo apermo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine to me.

@kebbet
Copy link
Copy Markdown
Author

kebbet commented Oct 6, 2024

@apermo Any suggestions or insights in the @throws in debug_data docblock?

@apermo
Copy link
Copy Markdown

apermo commented Oct 6, 2024

@apermo Any suggestions or insights in the @throws in debug_data docblock?

That one is correct.

get_wp_media() can throw that, and it will bubble up to debug_data(), since there is no try catch it can bubble out, so it is correct to keep the @throws ImagickException in line 32.

But thanks for catching the other doc error.

@apermo
Copy link
Copy Markdown

apermo commented Oct 8, 2024

cc @dmsnell

Copy link
Copy Markdown
Contributor

@peterwilsoncc peterwilsoncc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, thank you!

Sorry about the delay reviewing.

@peterwilsoncc
Copy link
Copy Markdown
Contributor

Merged r59290 / baf408f

@kebbet kebbet deleted the 61648-docs branch October 25, 2024 05:16
@dmsnell
Copy link
Copy Markdown
Member

dmsnell commented Oct 29, 2024

Thanks all for your work on this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants