I have a scenario where I think it might be warranted to depart from the end with an exclamation mark convention for function names that modify at least one of their arguments. However, I wouldn’t want to get into an anti-pattern here - so I am really curious about your take on this. I think the b…

The ! is just a convention, designed to be a helpful signal to end users about what the function may or may not do. IMO it all depends on the use-case and how you might imagine callers reasoning about the function call.

Breaking notation convention - a potential anti-pattern?

General Usage

gdalle July 18, 2023, 5:25am 15

Actually, my “don’t” was a response to this, as in “don’t even go there it is beyond cursed”

Topic		Replies	Views
Why is bang(!) indicating argument mutation a convention, but not enforced? Internals & Design	15	2620	November 18, 2020
! notation for individual modified variables Internals & Design proposal	39	3508	April 11, 2019
Should a function be named with `!` if it only modifies a container type's inner values? General Usage function	6	263	July 12, 2023
Naming convention for functions when an argument is optionally mutated General Usage syntax , argument , function	5	173	January 25, 2025
Mutating function-like objects, enforcing "!"? General Usage question , function , functions , function-like-object	6	358	July 21, 2023

Breaking notation convention - a potential anti-pattern?

Related topics