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

Docs/WordPress.WhiteSpace.PrecisionAlignment #1725

Merged
merged 9 commits into from Jul 5, 2019
Merged

Docs/WordPress.WhiteSpace.PrecisionAlignment #1725

merged 9 commits into from Jul 5, 2019

Conversation

ckanitz
Copy link
Contributor

@ckanitz ckanitz commented Jun 20, 2019

Adds documentation for the WordPress.WhiteSpace.PrecisionAlignmentSniff

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 Reviewer approved Jun 23, 2019
XML Documentation automation moved this from Reviewer approved to Review in progress Jun 27, 2019
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.

Hi @ckanitz Thank you so much for this PR.

Generally speaking, it looks good. Just a few minor suggestions from my side.

Also: could you please make sure the indentation within the XML file is consistently done with spaces ?
The current file seems to have a mix of space/tab indentation.

WordPress/Docs/WhiteSpace/PrecisionAlignmentStandard.xml Outdated Show resolved Hide resolved
</code>
</code_comparison>
<code_comparison>
<code title="Valid: four spaces will be replaced by the upstream sniff.">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<code title="Valid: four spaces will be replaced by the upstream sniff.">
<code title="Valid: four spaces counts as a tab, the replacement of these will be handled by another sniff.">

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.

Darn.. I'm still forgetting one thing: would you mind adding <em>...</em> tags around the "good" and "bad" bits (i.e. the tab/space sequences) ? This allows the markdown and HTML generators to highlight this better.

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.

Hi @ckanitz Thanks for making those changes. One stray "not" had creeped in via one of my suggestions. Sorry about that, but I've fixed that up myself now. Approving & merging. 🎉

XML Documentation automation moved this from Review in progress to Reviewer approved Jul 5, 2019
@jrfnl jrfnl merged commit d00b44b into WordPress:develop Jul 5, 2019
XML Documentation automation moved this from Reviewer approved to Done Jul 5, 2019
@jrfnl jrfnl added this to the 2.x Next milestone Jul 8, 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