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

Turn the "eternal" handbook date into symbols #1021

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Turn the "eternal" handbook date into symbols #1021

wants to merge 1 commit into from

Conversation

mih
Copy link
Collaborator

@mih mih commented Aug 11, 2023

We fix the committer date in the handbook for reasons of reproducibility (no random shasum changes, simply because we execute code at a different time). Hence the dates/times shown do not really make sense (they appear constant, even across multiple steps of a procedure. This appears odd.

This changeset replace the timestamps with symbolic placeholders.

Their meaning still needs to be described in the intro.

Ping #1009

We fix the committer date in the handbook for reasons of reproducibility
(no random shasum changes, simply because we execute code at a different
time). Hence the dates/times shown do not really make sense (they appear
constant, even across multiple steps of a procedure. This appears odd.

This changeset replace the timestamps with symbolic placeholders.

Their meaning still needs to be described in the intro.

Ping #1009
@mih
Copy link
Collaborator Author

mih commented Aug 11, 2023

The regex does not have the desired effect. Unclear why.

@mih mih marked this pull request as draft August 11, 2023 09:57
Copy link
Collaborator

@mslw mslw left a comment

Choose a reason for hiding this comment

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

I think I figured out the regexp @mih (see inline comments), so if you are still interested in having the replacement, then we can go ahead. A TODO from the commit message ("their meaning still needs to be described in the intro") still applies.

FTR, this is what git log run record from 101-101-create looks like in my browser:

Screenshot from 2024-05-21 11-31-25

Comment on lines +38 to +39
(r'Tue Jun 18 16:13:00 2019 +0000', '🗓🕓'),
(r'2019-06-18 16:13', '🗓🕓'),
Copy link
Collaborator

Choose a reason for hiding this comment

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

I see two reasons why the regexp would not work:

  • The plus symbol needs to be escaped (otherwise it's "space, one or more, followed by 0000")
  • The time zone can not be taken for granted, the config sets git author & committer date to 2019-06-18T16:13:00, and for me this produces run records with git log saying Tue Jun 18 16:13:00 2019 +0200 (I'm in CEST).

I'm also adding a space for IMHO better aesthetics.

Suggested change
(r'Tue Jun 18 16:13:00 2019 +0000', '🗓🕓'),
(r'2019-06-18 16:13', '🗓🕓'),
(r'Tue Jun 18 16:13:00 2019 \+\d{4}', '🗓 🕓'),
(r'2019-06-18 16:13', '🗓 🕓'),

Comment on lines +38 to +39
(r'Tue Jun 18 16:13:00 2019 +0000', '🗓🕓'),
(r'2019-06-18 16:13', '🗓🕓'),
Copy link
Collaborator

Choose a reason for hiding this comment

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

As a side note, I would use 📅 (Calendar, U+1F4C5) instead of 🗓 (Spiral Calendar Pad, U+1F5D3), but that's a personal preference and likely depends on my set of browser fonts (?) -- not leaving a GitHub suggestion as this would require a one-line change to fontpkg.sty, too.

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