-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Corrections to "Advanced Vector Math" #589
Conversation
typos and code correction
@@ -169,7 +169,7 @@ Some examples of planes | |||
Here is a simple example of what planes are useful for. Imagine you have | |||
a `convex <http://www.mathsisfun.com/definitions/convex.html>`__ | |||
polygon. For example, a rectangle, a trapezoid, a triangle, or just any |
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 think I would change this to be something like "...polygon, such as a triangle, rectangle, or trapezoid."
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 tried to be as non-intrusive as I could. I only edited the typos and mistakes. I'm very inexperienced so I probably have to be very cautious.
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 understand. The majority of my own contributions to this repository are non-intrusive spelling and grammar corrections!
I should have added this comment on the line below to be more clear: As you are changing this sentence already, I think it would work just as well if you simplified it further and merged it into the previous sentence. No need to worry about it getting accepted, as I already have approved the change.
EDIT: If you still don't feel comfortable making the change, the pull request is acceptable as it is. Just let us know.
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.
@amirea Please let us know whether or not you are interested in making any further refinements to this sentence. If not, this is ready to merge.
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.
It's good. And also if it's OK with you, please merge it.
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.
Looks good, in general. Besides my one suggestion for change, a more descriptive commit message would also be nice. Something like Corrections to "Advanced Vector Math"
This whole article is need of a major rewrite. Ref #532 |
@cbscribe That's fine, this contribution can still be accepted despite the rest of the article needing more work. |
Sure - just trying to encourage some deeper revisions ;) |
I looked for a way to edit the commit title but I couldn't find any. At least I'll know for next time. |
# or alternatively | ||
# var normal = Vector2(-dvec.y,dev.x) | ||
# var normal = Vector2(-dvec.y,dvec.x) |
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.
While you're at it, add a space after the , for readability - here and above.
As far as I know, there is no way to edit commits on GitHub. It is not a problem, I can clean it up a bit before merging. |
The only way is another commit that will overwrite the previous. Now I'm working at that file + another ones. I probably was not inspire to just pr a single file in the first place. I should have work on a larger part of the doc. and only after that make the request. |
Making PRs that only include small changes to one file is completely acceptable, in my opinion. You can just keep making PRs whenever you feel like contributing. |
Corrections to "Advanced Vector Math"
I made the history prettier (one commit with a more descriptive message), so your contribution is in c27d32e. Thanks for your efforts! Edit: To clarify, you still get the credit as the author. |
Thank you for the kindness and support shown. I'll double my efforts in the future. |
Fixed typos and code bugs. Please double check as I'm 98% sure about it.