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

rodrigoprimo · 2024-03-27T13:18:12Z

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 #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.
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

Thank you @rodrigoprimo !

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

I've not checked each individual link. If any issues are found with those at some point in the future, whomever finds the issue is welcome to submit a PR to fix the link ;-)

jrfnl · 2024-03-28T17:38:42Z

CHANGELOG.md

+- Fixed bug [#9274][pear-9274] : nested_parenthesis element not set for open and close parenthesis tokens
+- Fixed bug [#9411][pear-9411] : too few pattern characters cause incorrect error report
+
+[pear-9274]: https://pear.php.net/bugs/bug.php?id=9274


Duplicate link - see line 6644 (the link should remain in the link list for the oldest version in which it is referenced, the link in the link list for the newer version should be removed).

jrfnl · 2024-03-28T17:43:22Z

CHANGELOG.md

+[pear-14077]: https://pear.php.net/bugs/bug.php?id=14077
+[pear-14168]: https://pear.php.net/bugs/bug.php?id=14168
+[pear-14238]: https://pear.php.net/bugs/bug.php?id=14238
+[pear-14249]: https://pear.php.net/bugs/bug.php?id=14249
+[pear-14250]: https://pear.php.net/bugs/bug.php?id=14250
+[pear-14251]: https://pear.php.net/bugs/bug.php?id=14251


These all look like duplicates to me - see line 6121-6126

jrfnl · 2024-03-28T17:52:52Z

CHANGELOG.md

+[pear-19819]: https://pear.php.net/bugs/bug.php?id=19819
+[pear-19820]: https://pear.php.net/bugs/bug.php?id=19820
+[pear-19843]: https://pear.php.net/bugs/bug.php?id=19843
+[pear-19859]: https://pear.php.net/bugs/bug.php?id=19859
+[pear-19863]: https://pear.php.net/bugs/bug.php?id=19863
+[pear-19871]: https://pear.php.net/bugs/bug.php?id=19871
+[pear-19879]: https://pear.php.net/bugs/bug.php?id=19879


These all look like duplicates to me - see line 4979-4985

jrfnl · 2024-03-28T17:54:15Z

CHANGELOG.md

+[pear-19811]: https://pear.php.net/bugs/bug.php?id=19811
+[pear-19892]: https://pear.php.net/bugs/bug.php?id=19892
+[pear-19897]: https://pear.php.net/bugs/bug.php?id=19897
+[pear-19908]: https://pear.php.net/bugs/bug.php?id=19908
+[pear-19930]: https://pear.php.net/bugs/bug.php?id=19930
+[pear-19935]: https://pear.php.net/bugs/bug.php?id=19935
+[pear-19944]: https://pear.php.net/bugs/bug.php?id=19944
+[pear-19953]: https://pear.php.net/bugs/bug.php?id=19953
+[pear-19956]: https://pear.php.net/bugs/bug.php?id=19956
+[pear-19957]: https://pear.php.net/bugs/bug.php?id=19957
+[pear-19968]: https://pear.php.net/bugs/bug.php?id=19968
+[pear-19969]: https://pear.php.net/bugs/bug.php?id=19969
+[pear-19997]: https://pear.php.net/bugs/bug.php?id=19997


These all look like duplicates to me - see line 4875-4887

jrfnl · 2024-03-28T18:05:04Z

CHANGELOG.md

+[pear-20026]: https://pear.php.net/bugs/bug.php?id=20026
+[pear-20029]: https://pear.php.net/bugs/bug.php?id=20029
+[pear-20043]: https://pear.php.net/bugs/bug.php?id=20043
+[pear-20044]: https://pear.php.net/bugs/bug.php?id=20044
+[pear-20045]: https://pear.php.net/bugs/bug.php?id=20045
+[pear-20050]: https://pear.php.net/bugs/bug.php?id=20050


These all look like duplicates to me - see line 4727-4732

rodrigoprimo · 2024-04-01T20:02:45Z

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 · 2024-04-01T20:29:33Z

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 · 2024-04-02T15:45:51Z

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.

jrfnl

Thanks @rodrigoprimo ! It's great to see the changelog improved so much (via this and the other PRs) !

) * Add links to all issues in the remaining sessions of the changelog * Fix typos * Remove duplicate issue links added in a previous commit in this branch * Remove duplicate issue links from the changelog

rodrigoprimo added 2 commits March 27, 2024 09:39

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

c7216db

Fix typos

13da387

github-actions bot added Type: documentation Status: triage labels Mar 27, 2024

rodrigoprimo changed the title ~~Changelog improvements remaining versions~~ Add links to all issues in the remaining sections of the changelog Mar 27, 2024

jrfnl added this to the 3.9.1 milestone Mar 28, 2024

jrfnl removed the Status: triage label Mar 28, 2024

jrfnl requested changes Mar 28, 2024

View reviewed changes

jrfnl added the Status: awaiting feedback label Mar 28, 2024

jrfnl modified the milestones: 3.9.1, 3.9.2 Mar 31, 2024

rodrigoprimo added 2 commits April 2, 2024 12:24

Remove duplicate issue links added in a previous commit in this branch

24098ee

Remove duplicate issue links from the changelog

42c0e0b

rodrigoprimo force-pushed the changelog-improvements-remaining-versions branch from a94b83e to 42c0e0b Compare April 2, 2024 15:41

jrfnl removed the Status: awaiting feedback label Apr 2, 2024

jrfnl approved these changes Apr 3, 2024

View reviewed changes

jrfnl merged commit 75f073b into PHPCSStandards:master Apr 3, 2024
38 checks passed

rodrigoprimo deleted the changelog-improvements-remaining-versions branch April 5, 2024 13:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

rodrigoprimo commented Mar 27, 2024

jrfnl left a comment •

edited

Loading

jrfnl Mar 28, 2024

jrfnl Mar 28, 2024

jrfnl Mar 28, 2024

jrfnl Mar 28, 2024

jrfnl Mar 28, 2024

rodrigoprimo commented Apr 1, 2024

jrfnl commented Apr 1, 2024

rodrigoprimo commented Apr 2, 2024

jrfnl left a comment

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

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

Conversation

rodrigoprimo commented Mar 27, 2024

Description

Related issues/external references

Types of changes

PR checklist

jrfnl left a comment • edited Loading

Choose a reason for hiding this comment

jrfnl Mar 28, 2024

Choose a reason for hiding this comment

jrfnl Mar 28, 2024

Choose a reason for hiding this comment

jrfnl Mar 28, 2024

Choose a reason for hiding this comment

jrfnl Mar 28, 2024

Choose a reason for hiding this comment

jrfnl Mar 28, 2024

Choose a reason for hiding this comment

rodrigoprimo commented Apr 1, 2024

jrfnl commented Apr 1, 2024

rodrigoprimo commented Apr 2, 2024

jrfnl left a comment

Choose a reason for hiding this comment

jrfnl left a comment •

edited

Loading