[Documentation] PSR12 - Import Statement

[dingo-d]

The PR contains the documentation for the PSR12/Files/ImportStatement sniff.

Description

This PR will add the documentation for the above-mentioned sniff, according to the official standard definitions.

Suggested changelog entry

Add documentation for the PSR12 ImportStatement sniff

Related issues/external references

Part of #148

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]

Hi @dingo-d Thanks for yet another good PR!

When looking this over, my main question is about the code samples: they seem to contain a lot of "fluff", i.e. code which is not directly related to the rule being checked.

Is there a particular reason for that ? Could the code samples be simplified down to a smaller sample which still makes the rule clear ? (and will prevent confusing the import use statement with a trait use statement)

[dingo-d]

Is there a particular reason for that ? Could the code samples be simplified down to a smaller sample which still makes the rule clear ? (and will prevent confusing the import use statement with a trait use statement)

Tbh no particular reason, I guess I thought having context would help. Even though in that case, actually using or extending some classes would make more sense. Also, having trait use statements there to showcase the difference could be useful.

I will remove the extra 'fluff' and modify the examples 😄 👍🏼

[jrfnl]

@dingo-d Is this one ready for a final review ?

[dingo-d]

@dingo-d Is this one ready for a final review ?

Yes 👍🏼

[jrfnl]

Why are there trait import statements in the code sample ? The sniff does not apply to those. This is confusing.

[dingo-d]

Why are there trait import statements in the code sample ? The sniff does not apply to those. This is confusing.

Just looked at the tests, where it was added probably to check those won't trigger the sniff.

In the context of the docs it could be confusing. I'll renove them 👍🏼

[jrfnl]

Thanks @dingo-d ! LGTM.