Add links to all issues in the remaining sections of the changelog

rodrigoprimo commented 5 months ago

Description

This PR adds links to all issues in the remaining sections of the changelog. It also fixes a few typos. Contrary to what I did in previous PRs related to #244, here I did not read through all the text looking for typos. I only fixed the typos highlighted by my IDE as it would take a long time to read everything. I also opted to fix the typos in a separate commit that can be squashed before merging as the number of changes in this PR is much bigger than in previous PRs. I'm hoping that this will make the review process easier.

Related issues/external references

Part of https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/244

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.
[x] 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).
[x] I have added tests to cover my changes.
[x] I have verified that the code complies with the projects coding standards.
[x] [Required for new sniffs] I have added XML documentation for the sniff.

rodrigoprimo commented 5 months ago

Thanks for the review, @jrfnl!

Aside from some issues with duplicate links in link lists (didn't we discuss those before ?), this looks good.

I missed the duplicate links. I remember us discussing duplicate links in the same version, but I don't remember us discussing duplicate links across different versions. I could have inferred that, but unfortunately, I did not.

I pushed a new commit removing the duplicates.

I noticed duplicate links added in previous PRs. Would you prefer that I push a commit fixing those to this PR or create a separate PR?

jrfnl commented 5 months ago

I missed the duplicate links. I remember us discussing duplicate links in the same version, but I don't remember us discussing duplicate links across different versions. I could have inferred that, but unfortunately, I did not.

Well, the previous issue was already across versions as the links between Squiz and this repo were overlapping with the links to this repo only being in recent changelogs (and the links to Squiz in older changelogs).

While duplicate link definitions which have the same URL attached is not necessarily problematic, it is still not a good idea to have them, as if one is updated, but not the other, which one should be used ? (hint: the first one found will be used, but that may not be the one updated).

You may want to read up a little on markdown. These may be good starting points:

I pushed a new commit removing the duplicates.

I noticed duplicate links added in previous PRs. Would you prefer that I push a commit fixing those to this PR or create a separate PR?

Please feel free to fix them up in this PR.

rodrigoprimo commented 5 months ago

Thanks for the additional information, @jrfnl.

I added the new commit fixing the other duplicate links in the file and this PR is ready for a final review.

PHPCSStandards / PHP_CodeSniffer