Programming

17436 readers

298 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 1 year ago

MODERATORS

[email protected]

Naming Functions: When Intent and Implementation Differ (chrisoldwood.blogspot.com)

submitted 7 months ago by [email protected] to c/[email protected]

5 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 4 points 7 months ago (2 children)

I would use reportMissingData

[–] [email protected] 9 points 7 months ago (1 children)

See, both report and record signify different things in my mind. The original code was just printing to stdout.

In my mind logMissingData makes more sense because it's not actively sending anything; it's just logging.

[–] [email protected] 4 points 7 months ago

I agree that report and record are different. To me record means it's preserved in some managed way.

The implementation has the ability to vary quite widely from simply printing to stdout, logging to a file, writing to a queue / database, and yet the same name will continue to reflect all those possibilities

This makes it sound like the intent goes beyond logging, but not so far as recording. That's how I come to 'report' as the correct verb.

[–] [email protected] 4 points 6 months ago

I would use reportMissingData

Agreed, report feels clearer as the verb "record" is more about permanent storage and later reference.

Or even just reportMissing? Depending on what's happening around call sites, I often find I can drop generic stuff like "Data" and it's just as clear, especially when looking at a function signature. For instance:

func reportMissing(data) { ... }