[Bad Example] Function names should say what they do

[peter-gribanov]

Function names should say what they do

Bad:

function addToDate(\DateTime $date, $month) {
    $date->modify(sprintf('+%d months', $month));
}

$date = new \DateTime();

// It's hard to to tell from the function name what is added
addToDate($date, 1);

Good:

function addMonthToDate($month, \DateTime $date) {
    $date->modify(sprintf('+%d months', $month));
}

$date = new \DateTime();
addMonthToDate(1, $date);

What is the purpose of addToDate()/addMonthToDate() functions?
What are they needed for?
These functions are meaningless.

[hailwood]

perhaps something more like

class Email 
{
    //...

    public function handle() {
        mail($this->to, $this->subject, $this->body);
    }

}

$message = new Email(...);
// What is this? A handle for the message? Are we writing to a file now?
$message->handle();

compared to

class Email 
{
    //...

    public function send() {
        mail($this->to, $this->subject, $this->body);
    }

}

$message = new Email(...);
// Clear and obvious
$message->send();

[peter-gribanov]

@hailwood your example i like more

[piotrplenik]

@hailwood Could you create PR for that?

[TomasVotruba]

Closed by #44