Skip to content

#63166 Convert some @internal tags into inline tags.#8837

Closed
johnbillion wants to merge 1 commit intoWordPress:trunkfrom
johnbillion:internal
Closed

#63166 Convert some @internal tags into inline tags.#8837
johnbillion wants to merge 1 commit intoWordPress:trunkfrom
johnbillion:internal

Conversation

@johnbillion
Copy link
Copy Markdown
Member

The @internal tag is an odd one, it has a different meaning depending on whether it's used as a top-level tag or an inline tag. Quoting the phpDocumentor docs:

The @internal tag is used to denote that associated Structural Elements are internal to the application or library. It may also be used inside a long description to insert a piece of text that is only applicable for the developers of the software.

So the former denotes that the symbol is for internal use only, and the latter denotes some internal documentation.

This PR fixes some instances of top level @internal tags that should be inline tags.

@github-actions
Copy link
Copy Markdown

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 johnbillion.

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

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.

Comment on lines +2098 to +2099
* {@internal The $comment global must be present to allow template tags access to the current
* comment. See https://core.trac.wordpress.org/changeset/36512.}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
* {@internal The $comment global must be present to allow template tags access to the current
* comment. See https://core.trac.wordpress.org/changeset/36512.}
* {@internal The $comment global must be present to allow template tags access to the current
* comment. See https://core.trac.wordpress.org/changeset/36512.}

Nit

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Looks like this should be fully inline rather than indented because it's an inline tag. I'll do that when I commit it. Thanks!

@johnbillion
Copy link
Copy Markdown
Member Author

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.

2 participants