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

have year shortened to 'yr' not 'a' #1940

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

mpsheasby
Copy link

  • Closes # (insert issue number)
  • Executed pre-commit run --all-files with no errors
  • The change is fully covered by automated unit tests
  • Documented in docs/ as appropriate
  • Added an entry to the CHANGES file

Unsure as to why year is abbreviated to 'a' and propose we abbreviate to 'yr' instead.

Have made proposal accordingly, although not tested the result of these changes, please let me know if you agree then we can test the change has the desired results.

@dalito
Copy link
Contributor

dalito commented Feb 26, 2024

Why "a"? From latin "annum".

@mpsheasby
Copy link
Author

Thanks @dalito .

In my user group (structural engineers) everyone was perplexed, but I suspect this may be a question of technical background/ industry.

Thoughts from anyone else on which is better?

@hgrecco
Copy link
Owner

hgrecco commented Mar 9, 2024

Indeed, it is from latin "annum". I am not sure if there is a canonical way. I would say the following: if there is a "rule" (i.e. from NIST) that suggest 'yr' I would agree to change it.

@dalito
Copy link
Contributor

dalito commented Mar 9, 2024

The IEEE-Style manual for example suggests "a". https://journals.ieeeauthorcenter.ieee.org/your-role-in-article-production/ieee-editorial-style-manual/

The current SI brochure (and NIST SI-guides) suggest to not abbreviate units. Note that "year" is not among the accepted non-SI units so no unit symbol is suggested in the SI brochure.

Interestingly, LLMs (gemini/chatGPT) are insisting on "yr" and cite sources incorrectly. gemini suggested the IEEE-Style guide that explicitly lists "a" as abbreviation as a source for "yr". chatGPT suggested the SI brochure.

So maybe "yr" could be added as another abbreviation but it should not replace "a".

@mpsheasby
Copy link
Author

mpsheasby commented Mar 12, 2024

Thank you for looking into this further. I have some more considerations to add:

See also this wikipedia article
https://en.wikipedia.org/wiki/Year

"In English, the unit of time for year is commonly abbreviated as "y" or "yr". The symbol "a" (for Latin: annus, year) is sometimes used in scientific literature, though its exact duration may be inconsistent."

If you search "what does "a" mean unit" in google you don't get anything suggesting "year".

If you search "what does "yr" mean unit" in google the top results point to "year".

All of this (and the LLM results) point to "yr" or "y" as being the commonly used and understood, and "a" as generally not understood and difficult to understand if you were not already familiar (not even coming up on google search results). So from a useability perspective, I would prefer "yr".

@mpsheasby
Copy link
Author

To add, despite the summary at the start, there is some fairly detailed discussion further down that Wikipedia article, which does offer some more conflicting points.

https://en.wikipedia.org/wiki/Year#Symbols_and_abbreviations

@hgrecco
Copy link
Owner

hgrecco commented Mar 13, 2024

While I do personally prefer yr, I agree with @dalito. We should keep yr as secondary abbreviation but keep a as default. Having said that, we need a better way to modify small things within the definitions programatically.

Copy link

codspeed-hq bot commented Mar 13, 2024

CodSpeed Performance Report

Merging #1940 will not alter performance

Comparing mpsheasby:patch-1 (132ad3d) with develop (3cc2d36)

Summary

✅ 439 untouched benchmarks

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.

3 participants