Skip to content
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.

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

Remove commit references from event release history tables #327

Closed
magnusbaeck opened this issue Oct 31, 2022 · 0 comments · Fixed by #354
Closed

Remove commit references from event release history tables #327

magnusbaeck opened this issue Oct 31, 2022 · 0 comments · Fixed by #354
Assignees

Comments

@magnusbaeck
Copy link
Member

Description

Some event release history table entries contain references to the commit where the event version was introduced. This is awkward since you can't possibly include such a reference in the commit where it belongs. Working around that problem by using multiple commits or similar isn't worth the effort since you can just use git log to find this information. Let's remove those references and consistently use "No edition set" (or whatever #326 says we should use).

Motivation

Consistency and avoiding SHA-1 references makes for less work updating the event release history tables.

Exemplification

N/A

Benefits

  • No hoop-jumping required to get SHA-1 references in the tables.
  • More consistent experience for documentation readers and writers alike.

Possible Drawbacks

One could argue that it's a loss to not get commit references in these tables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant