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

Core: A comment at the end of long blocks is no longer required #964

Closed
pento opened this Issue Jun 15, 2017 · 4 comments

Comments

Projects
None yet
4 participants
@pento
Member

pento commented Jun 15, 2017

This rule can be removed.

<!-- Covers rule: If you consider a long block unavoidable, please put a short comment at the end ...
- typically this is appropriate for a logic block, longer than about 35 rows. -->
<rule ref="Squiz.Commenting.LongConditionClosingComment">
<properties>
<property name="lineLimit" value="35"/>
<property name="commentFormat" value="// End %s()."/>
</properties>
<exclude name="Squiz.Commenting.LongConditionClosingComment.SpacingBefore"/>
</rule>

@JDGrimes JDGrimes added this to the 0.12.0 milestone Jun 15, 2017

@GaryJones

This comment has been minimized.

Show comment
Hide comment
@GaryJones

GaryJones Jun 15, 2017

Member

Noting, that the Handbook was already changed to remove this as well.

Member

GaryJones commented Jun 15, 2017

Noting, that the Handbook was already changed to remove this as well.

@jrfnl

This comment has been minimized.

Show comment
Hide comment
@jrfnl

jrfnl Jun 15, 2017

Contributor

@pento Regarding the handbook update: looks like something has gone wrong with the encoding of entities in the code samples. You may want to fix that. I've pasted an example below.

<?php
// Before:
eat ( 'noodles', array( 'speed' =&gt; 'moderate' ) );

// After the update:
eat ( 'noodles', array( 'speed' =&amp;amp;gt; 'moderate' ) );
Contributor

jrfnl commented Jun 15, 2017

@pento Regarding the handbook update: looks like something has gone wrong with the encoding of entities in the code samples. You may want to fix that. I've pasted an example below.

<?php
// Before:
eat ( 'noodles', array( 'speed' =&gt; 'moderate' ) );

// After the update:
eat ( 'noodles', array( 'speed' =&amp;amp;gt; 'moderate' ) );
@pento

This comment has been minimized.

Show comment
Hide comment
@pento

pento Jun 15, 2017

Member

Thanks for the heads up, @jrfnl, fixed. 🙃

Member

pento commented Jun 15, 2017

Thanks for the heads up, @jrfnl, fixed. 🙃

@jrfnl

This comment has been minimized.

Show comment
Hide comment
@jrfnl

jrfnl Jun 15, 2017

Contributor

PR #965 should fix this.

Contributor

jrfnl commented Jun 15, 2017

PR #965 should fix this.

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