Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DontExtractStandard.xml file creation #2456

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

aiolachiara
Copy link

@aiolachiara aiolachiara commented Jun 13, 2024

Related to #1722

fix incomplete description of invalid use case description
Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

@aiolachiara Thank you for working on this!

I agree with the remark @GaryJones left previously and have added a few more nitpick comments inline.

I look forward to seeing the next iteration of the PR!

WordPress/Docs/PHP/DontExtractStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/PHP/DontExtractStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/PHP/DontExtractStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/PHP/DontExtractStandard.xml Outdated Show resolved Hide resolved
my_extract( $var_array, EXTR_OVERWRITE );
]]>
</code>
<code title="Invalid: use `extract()` function">
Copy link
Member

@jrfnl jrfnl Jul 22, 2024

Choose a reason for hiding this comment

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

Suggested change
<code title="Invalid: use `extract()` function">
<code title="Invalid: Using the `extract()` function.">

WordPress/Docs/PHP/DontExtractStandard.xml Outdated Show resolved Hide resolved
@rodrigoprimo
Copy link
Collaborator

@aiolachiara, I was just wondering if you'll have a chance to finish this off in the near future. It would be great if this PR could be included in the next WPCS release.

If you haven't got time or lost interest, please let us know and we'll see if we can find someone to take over. Thanks!

@aiolachiara
Copy link
Author

@aiolachiara, I was just wondering if you'll have a chance to finish this off in the near future. It would be great if this PR could be included in the next WPCS release.

If you haven't got time or lost interest, please let us know and we'll see if we can find someone to take over. Thanks!

@rodrigoprimo, I'm sorry for forgetting to complete this PR. I made some fixes to the documentation, and I hope to have included all the suggestions received.

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

@aiolachiara Thank you for making those updates! All looking good.

Only thing left is to use proper punctuation for the Valid/Invalid title (i.e. add a . at the end of each sentence + add the missing "the" in the Invalid title), but we can fix that up on merge if needs be. Let me know if you want to fix this up yourself still or if you prefer we fix it up on merge.

@aiolachiara
Copy link
Author

@aiolachiara Thank you for making those updates! All looking good.

Only thing left is to use proper punctuation for the Valid/Invalid title (i.e. add a . at the end of each sentence + add the missing "the" in the Invalid title), but we can fix that up on merge if needs be. Let me know if you want to fix this up yourself still or if you prefer we fix it up on merge.

I fixed punctuation and misspellings, I hope It is fine now.

Copy link
Member

@jrfnl jrfnl left a comment

Choose a reason for hiding this comment

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

@aiolachiara Awesome! Thank you for the quick turn-around. All good from me now ✔️

Copy link
Member

@dingo-d dingo-d left a comment

Choose a reason for hiding this comment

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

Just one comment left, otherwise looks good 👍🏼

<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="Don't extract"
Copy link
Member

Choose a reason for hiding this comment

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

I know that the sniff is called DontExtract, but maybe the title can be Don't use extract()? To be a bit more clear?

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

Successfully merging this pull request may close these issues.

5 participants