Reword "clue" sentence

This sounds more natural and professional
This commit is contained in:
evazorro 2018-10-18 11:41:34 -04:00 committed by GitHub
parent 8c31fae9fa
commit e06b51996a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -334,7 +334,7 @@ So, it effectively becomes an empty return. We should put the value on the same
## Naming a function [#function-naming]
Functions are actions. So their name is usually a verb. It should briefly, but as accurately as possible describe what the function does. So that a person who reads the code gets the right clue.
Functions are actions. So their name is usually a verb. It should briefly, but as accurately as possible, describe what the function does, so that someone reading the code gets an indication of what the function does.
It is a widespread practice to start a function with a verbal prefix which vaguely describes the action. There must be an agreement within the team on the meaning of the prefixes.