Skip to content

Prepare rand v0.9.1#1629

Merged
dhardy merged 1 commit intomasterfrom
push-pymznswuwlty
Apr 17, 2025
Merged

Prepare rand v0.9.1#1629
dhardy merged 1 commit intomasterfrom
push-pymznswuwlty

Conversation

@dhardy
Copy link
Member

@dhardy dhardy commented Apr 16, 2025

CHANGELOG updated.

@dhardy dhardy requested a review from newpavlov April 16, 2025 11:15

## [Unreleased]
- Remove `zerocopy` dependency (#1579)
## [0.9.1] - 2025-04-17
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW we probably need to add links for release versions (e.g. see the end of the getrandom's changelog), but we can do it in a separate PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we? Those don't have to be links (and I don't believe it adds much utility).

Copy link
Member

@newpavlov newpavlov Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then we need to remove the square brackets around versions, otherwise we essentially have broken links in our changelog files. IIUC according to the keepachangelog scheme (scroll to the very end of the example file), which we declare to follow, those are intended to be links.

Copy link
Member Author

@dhardy dhardy Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown is permissive with syntax. The definition of a reference link in GFM is:

A full reference link consists of a link text immediately followed by a link label that matches a link reference definition elsewhere in the document.

I never saw anything suggesting that Markdown should lint against usage of this syntax without a matching link reference definition.

But if you really want to use the keepachangelog scheme then the "unreleased" link should compare against HEAD like this, not use a dead link as in the getrandom changelog (which is something that a link checker should lint against).

P.S. I'm not against doing this; I just can't be bothered (and disagree that using square brackets [like this] is wrong).

Copy link
Member

@newpavlov newpavlov Apr 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point is that the square brackets around versions in the keepachangelog scheme are used for references, not to make versions more noticeable.

the "unreleased" link should compare against HEAD

Yes, we should fix it.

@dhardy dhardy merged commit db993ec into master Apr 17, 2025
15 checks passed
@dhardy dhardy deleted the push-pymznswuwlty branch April 17, 2025 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants