Skip to content

changed single asterisks to double asterisks for ticket #60513#6132

Closed
mahnewr wants to merge 1 commit intoWordPress:trunkfrom
mahnewr:bugfix/60513/double-asterisks
Closed

changed single asterisks to double asterisks for ticket #60513#6132
mahnewr wants to merge 1 commit intoWordPress:trunkfrom
mahnewr:bugfix/60513/double-asterisks

Conversation

@mahnewr
Copy link
Copy Markdown

@mahnewr mahnewr commented Feb 16, 2024

I changed one of the /* to a /** to follow proper PHPDoc comments syntax

Trac ticket: https://core.trac.wordpress.org/ticket/60513

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions
Copy link
Copy Markdown

Hi @mahnewr! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in this blog post.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 16, 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 mahnewr, kraftbj, audrasjb, mukesh27, rudlinkon.

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.

Copy link
Copy Markdown

@kraftbj kraftbj left a comment

Choose a reason for hiding this comment

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

Changes look good to me.

@rudlinkon
Copy link
Copy Markdown

@mahnewr thanks for the PR, I think we can do the same fix for some places also. I have given two more places where we can apply the same fix.


@kraftbj
Copy link
Copy Markdown

kraftbj commented Feb 17, 2024

I would not change the bootstrap.php since that appears to be a simple multi line comment (see 5.2 of https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/ )

The WP Profiler looks like it could function as the docblock for the class, so it should and have the additional check for completeness, like @ since, etc.

Copy link
Copy Markdown
Member

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

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

Nice catch

@mukeshpanchal27
Copy link
Copy Markdown
Member

Ready for commit 🎉

@rudlinkon
Copy link
Copy Markdown

I would not change the bootstrap.php since that appears to be a simple multi line comment (see 5.2 of https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/ )

The WP Profiler looks like it could function as the docblock for the class, so it should and have the additional check for completeness, like @ since, etc.

Thank you @kraftbj so we can add double asterisks on the wp-profiler.php file.

@swissspidy
Copy link
Copy Markdown
Member

@swissspidy swissspidy closed this Feb 20, 2024
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.

6 participants