Lack of clarity for the prefix 'get' for global functions.

[polina-c]

Page URL

https://dart.dev/effective-dart/design

Page source

https://github.com/dart-lang/site-www/blob/main/src/content/effective-dart/design.md

Describe the problem

There are two rules that create room for interpretation:

1. https://dart.dev/effective-dart/design#avoid-starting-a-method-name-with-get
2. https://dart.dev/effective-dart/design#consider-an-imperative-verb-phrase-for-a-function-or-method-if-you-want-to-draw-attention-to-the-work-it-performs

If I have a global function (not method) that returns a value, is it recommended to give it prefix 'get':

1. getMostImportantValue()
2. mostImportantValue()

Expected fix

It would be nice to see this case clarified in effective dart to help teams save time arguing about interpretation.

Additional context

No response

I would like to fix this problem.

• I will try and fix this problem on dart.dev.

[parlough]

\cc @munificent @lrhn for thoughts.

Can you provide some concrete examples of functions that you're considering this for? Based off of the mentioned name mostImportantValue() and lack of arguments, that specific case seems like it should be a getter.

Or are you simply suggesting that the "AVOID starting a method name with get" guidance should be expanded to explicitly mention functions?

[polina-c]

Thank you for looking to it.

Yes, if "AVOID starting a method name with get" guidance will start mentioning functions explicitly, it will resolve the issue.

(My mostImportantValue() is not getter, because it can fail, so it is complicated enough to be function)

[munificent]

I'm sorry for the poor wording in that guideline. I've always intended it to apply to top-level functions as well as methods. We should probably reword it to "function or method".