Skip to content

Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs #384

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Mar 7, 2024
Merged

Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs #384

merged 2 commits into from
Mar 7, 2024

Conversation

jpoliveira08
Copy link
Contributor

@jpoliveira08 jpoliveira08 commented Mar 7, 2024 •
edited
Loading

Description

The aim of this PR is to fix the title of the XML documentation for the Sniff Generic.Formatting.NoSpaceAfterCastStandard. The current title states "Space After Casts" which seems different to the file name and the standard description.

Related issues/external references

Fixes #383

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the Contribution Guidelines.
  • I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added XML documentation for the sniff.

jrfnl
jrfnl reviewed Mar 7, 2024
View reviewed changes
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.

@jpoliveira08 Thank you for this PR.

I've left one suggestion inline to make the title reflect the sniff name even more precsiely.

Other than that, could you please have a look at the third checkbox under "PR checklist" ? Thank you!

@jpoliveira08
Making some Generic rules docs more precisely
36fffd0 
Docs changed:
Generic.Formatting.NoSpaceAfterCastStandard
Generic.Formatting.SpaceAfterCastStandard
@jpoliveira08
Copy link
Contributor Author

jpoliveira08 commented Mar 7, 2024 •
edited
Loading

@jrfnl Ready to review

Changes

  • Updated the title docs in Generic.Formatting.NoSpaceAfterCastStandard
  • Updated the title docs in Generic.Formatting.SpaceAfterCastStandard
  • Updated the "PR checklist"

@jrfnl jrfnl added this to the 3.9.1 milestone Mar 7, 2024
@jrfnl jrfnl merged commit e72c99b into PHPCSStandards:master Mar 7, 2024
@jrfnl
Copy link
Member

jrfnl commented Mar 7, 2024

@jpoliveira08 Thank you for making that update and congratulations on your first open source PR, submitted & merged within 24 hours. Well done and welcome to open source!

jrfnl pushed a commit that referenced this pull request Mar 7, 2024
@jpoliveira08 @jrfnl
Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs (#384
2a1020d 
)

* Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs

* Making some Generic rules docs more precisely

Docs changed:
Generic.Formatting.NoSpaceAfterCastStandard
Generic.Formatting.SpaceAfterCastStandard
@rodrigoprimo
Copy link
Contributor

Bem-vindo, @jpoliveira08! It's good to see another Brazilian around, and thanks for your contribution to the project.

@jpoliveira08
Copy link
Contributor Author

Muito obrigado @rodrigoprimo! Thank you so much @jrfnl!
I'm very happy, this is just the beginning!

@jrfnl
Copy link
Member

jrfnl commented Mar 8, 2024

... this is just the beginning!

I'm glad to hear that and look forward to your next contribution.

rodrigoprimo pushed a commit to rodrigoprimo/PHP_CodeSniffer that referenced this pull request Apr 22, 2024
@jpoliveira08 @rodrigoprimo
Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs (P…
f1e0719 
…HPCSStandards#384)

* Fixing the title of the Generic.Docs.NoSpaceAfterCastStandard docs

* Making some Generic rules docs more precisely

Docs changed:
Generic.Formatting.NoSpaceAfterCastStandard
Generic.Formatting.SpaceAfterCastStandard
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrfnl jrfnl jrfnl approved these changes

Assignees
No one assigned
Labels
Standard: Generic Type: documentation
Projects
None yet
Milestone
3.9.1
Development

Successfully merging this pull request may close these issues.

Possible Incorrect Title in XML doc for Sniff Generic.Formatting.NoSpaceAfterCastStandard
3 participants
@jpoliveira08 @jrfnl @rodrigoprimo