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

config: space before zone in default_time_format's default #2531

Merged
merged 1 commit into from
Nov 1, 2023

Conversation

dgw
Copy link
Member

@dgw dgw commented Oct 27, 2023

Description

Dates like 2023-10-26 - 23:45CDT look a bit weird, and should be presented as 2023-10-26 - 23:45 CDT. (The default timezone is still UTC, don't worry.)

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make lint and make test)
  • I have tested the functionality of the things this change touches

Notes

While making this, I noticed that Sphinx does not output any of the attribute values. Because of that, we have the same default value defined in three different places. The header line for each attribute ideally would look like a module-level constant, e.g. name_of_config_attribute = ListAttribute('name_of_config_attribute', default=['list', 'of', 'defaults']) (and ListAttribute there would link to the type, of course). It'd save us having to duplicate default values in docstrings, at least.

This patch can't do anything about it, and I couldn't figure out in half an hour of research how to change the docs so Sphinx would do it—but now I'm annoyed, so I wanted to pass that along to everyone else. 🤪

@dgw dgw added the Tweak label Oct 27, 2023
@dgw dgw added this to the 8.0.0 milestone Oct 27, 2023
@dgw dgw requested a review from a team October 27, 2023 05:10
Copy link
Contributor

@Exirel Exirel left a comment

Choose a reason for hiding this comment

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

Hm... this will probably break some tests for my plugins that uses the default time format... but heh, it's not that important tbh.

Copy link
Contributor

@SnoopJ SnoopJ left a comment

Choose a reason for hiding this comment

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

Seems like an easy win for legibility of the default. +1

@dgw dgw force-pushed the default_time_format-spacing branch from 37d5f95 to 650b474 Compare October 31, 2023 14:50
@dgw
Copy link
Member Author

dgw commented Oct 31, 2023

Just forcing the head SHA to change so CI will rebuild with the new Python 3.12 job. No changes!

@dgw dgw merged commit 5de26c1 into master Nov 1, 2023
15 checks passed
@dgw dgw deleted the default_time_format-spacing branch November 1, 2023 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants