So I have a somewhat obsessive need to use full words instead of abbreviations when I code. I think it really helps public library code to be readable and self-documenting. I was thinking today that I would have fun going through the JuliaLang/julia and replacing all abbreviations with full words. O…

The Linux Kernel also does not accept patches in which only the names of things are changed [image] Code Refactoring Code refactoring should not be done just because we can. There are a number of “refactoring” tickets that have been opened over time, such as suggestions to rename long-s…

The julia source seems heavily abbreviated to me, with most internal names being just one or two letters. I’m pretty sure Google wouldn’t approve.

No all abbreviations are bad, a lot depends on context. In simple cases, when they are perfectly understandable, abbreviations should be fine. Even if some existing code should benefit from expansion, it may be better to just leave it alone and wait for some substantial reason that requires touchin…

Related topic [image] Variable name style General Usage What’s your opinion? I tend to like single-letter variable names e.g. i, j, k for indices, w, h for width and height, s for any string, t for time, etc. Sometimes when I use meaningful / long names, I end up masking…

When we take Google as an authority, we should also consider the fact that Go has different style for variable names: Variable names in Go should be short rather than long. This is especially true for local variables with limited scope. Prefer c to lineCount . Prefer i to sliceIndex . The basic r…

Well, I specifically had to ask what, e.g., ptls stood for. A few longer words would definitely help

Pointer to thread local storage. There’s no way you’ll put this full name in. It’s not user facing and is not particularly well documented in the code and you are very welcome to add those comments around where it’s declaration in the header tls.h. A long version of the doc can be found in the defi…

I put my vote for a_variable_representing_pointer_to_thread_local_storage :grin:

TLS is a domain-standard abbreviation. ptls is not, however. If we’re nit picking on the names, I would suggest ptr_tls. [image] simonschoelly: When we take Google as an authority I wouldn’t suggest that Google has any authority over Julia coding style (nor do I speak for Google in any capac…

Abbreviations in source

Internals & Design

bramtayl April 14, 2019, 10:24pm 21

pointer_to_local_storage seems fine?

Topic		Replies	Views
Naming: Remove all underscores to matter what? General Usage	123	7930	January 28, 2018
Kate Gregory “Naming is Hard: Let's Do Better” and what lesson we can learn from it Teaching & Outreach discussion	34	2417	January 8, 2024
Digression on short variable names Offtopic	33	1738	December 25, 2022
Package naming guidelines Community	57	5421	January 11, 2026
Recommended style guide for naming functions is not practical General Usage	25	5419	February 26, 2019

Abbreviations in source

Related topics