Skip to content
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

Fix misleading description of MeshDataTool.get_vertex() method #81212

Merged

Conversation

mateuseap
Copy link
Contributor

What I did

  • Adjusted the description of MeshDataTool.get_vertex() method.
Closes: #80244

@mateuseap mateuseap requested a review from a team as a code owner September 1, 2023 00:14
@fire fire requested a review from a team September 1, 2023 02:13
fire
fire previously approved these changes Sep 1, 2023
Copy link
Member

@fire fire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can also be verbosely written as Returns the vertex position at the given vertex index.

Not sure if it's better.

@mateuseap
Copy link
Contributor Author

@fire, what are your thoughts on the new description? I aimed for brevity, but I'm open to adding more detail if you think it's necessary! Also, I liked your previous suggestion

Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is at least consistent with the rest of the description. That said, I'm not a huge fan of "the given vertex" when the user actually gives an index. But that can be a discussion for another day.

@akien-mga akien-mga merged commit f383249 into godotengine:master Sep 2, 2023
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@mateuseap mateuseap deleted the fix/meshDataToolClassReference branch September 3, 2023 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The description of get_vertex in MeshDataTool documentation can be misleading
4 participants