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

Documentation: New error handling Deprecated Classes and Functions #1729

Merged
merged 2 commits into from Sep 22, 2019
Merged

Documentation: New error handling Deprecated Classes and Functions #1729

merged 2 commits into from Sep 22, 2019

Conversation

fkeijzer
Copy link
Contributor

@fkeijzer fkeijzer commented Jun 20, 2019

Related to #1722

@GaryJones GaryJones added this to In progress in XML Documentation via automation Jun 20, 2019
XML Documentation automation moved this from In progress to Review in progress Jun 23, 2019
Copy link
Member

@GaryJones GaryJones left a comment

Choose a reason for hiding this comment

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

Are the valid and invalid examples correct here?

I see different parameter names in the examples, but the description is about values.

In this case, it should be string values that are used, not variable names:

Valid:

bloginfo( 'url' );
$tagline = get_bloginfo( 'description' );

Invalid:

bloginfo( 'siteurl' );
$home_url = get_bloginfo( 'home' );

These examples also then include indicators that it applies to bloginfo() and get_bloginfo().

Please also see the other comments.

WordPress/Docs/WP/DeprecatedParameterValuesStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/WP/DeprecatedParameterValuesStandard.xml Outdated Show resolved Hide resolved
XML Documentation automation moved this from Review in progress to Reviewer approved Jun 24, 2019
XML Documentation automation moved this from Reviewer approved to Review in progress Jun 24, 2019
Copy link
Member

@GaryJones GaryJones left a comment

Choose a reason for hiding this comment

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

A few more changes please.

WordPress/Docs/WP/DeprecatedFunctionsStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/WP/DeprecatedFunctionsStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/WP/DeprecatedParameterValuesStandard.xml Outdated Show resolved Hide resolved
WordPress/Docs/WP/DeprecatedParameterValuesStandard.xml Outdated Show resolved Hide resolved
@jrfnl
Copy link
Member

jrfnl commented Sep 20, 2019

FYI: @fkeijzer and me have sat down together at WordCamp Nijmegen today to review this.

The changes I've pushed now in the second commit have been made by us together.

@GaryJones Would you like to do one last look over ? (and merge if deemed ok)

XML Documentation automation moved this from Review in progress to Reviewer approved Sep 20, 2019
@GaryJones GaryJones merged commit 81a7fb2 into WordPress:develop Sep 22, 2019
XML Documentation automation moved this from Reviewer approved to Done Sep 22, 2019
@jrfnl jrfnl added this to the 2.2.0 milestone Oct 6, 2019
@jrfnl jrfnl changed the title New error handling Deprecated Classes and Functions Documentation: New error handling Deprecated Classes and Functions Oct 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants