Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Vector functions: Fix vector.direction() function, improve documentat…
…ion (#6801) vector.direction() now returns a normalised vector with direction p1 to p2.
- Loading branch information
1 parent
18b9210
commit d04c41a
Showing
2 changed files
with
38 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d04c41a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rubenwardy I was trained by hmmmm to always add a very concise summary phrase at the start of the first line of the commit message. It's useful because you can then scan your eye down the start of the commit messages and see the subject, without reading the whole line.
Looking at commit messages you can see most devs do this.
I can see in this case it's borderline redundant, however 'Vector functions' is still more useful to the eye than the rest of the line, so i think this is fairly reasonable.
d04c41a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree on that as you end up with pointless labels and inconsistency, but whatever.
The commit message is still bad as it is vague and overflows. At least remove the duplication, and maybe shorten to "docs".
d04c41a
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it was a bit duplicated and redundant, and too long, not great. Seems to overflow at 69 characters, it's a pain to count so mistakes happen. 'builtin vectors' is better, but my version is similar to yours so can't be particularly vague =)
Anyway i'll keep your request in mind.