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

Improve MeshDataTool.get_face_vertex() method description #81088

Merged

Conversation

mateuseap
Copy link
Contributor

@mateuseap mateuseap commented Aug 28, 2023

What I did

  • Improved the MeshDataTool.get_face_vertex() method description by making it more clear about what is the data type that is returned and adding a code example.

Closes: #7852 (issue from godot-docs repo)

@mateuseap mateuseap requested a review from a team as a code owner August 28, 2023 19:43
@AThousandShips AThousandShips added this to the 4.x milestone Aug 28, 2023
@AThousandShips
Copy link
Member

Would need a c# example as well, @raulsntos?

@clayjohn
Copy link
Member

Looks great! The final step before merging is to squash all the commits together so that the whole PR only contains 1 big commit with all your changes. We like to merge one commit at a time to keep the git history clean and navigable.

If you don't know how to do that, we have a helpful tutorial in the official documentation https://docs.godotengine.org/en/latest/community/contributing/pr_workflow.html#the-interactive-rebase

@mateuseap mateuseap changed the title Improve MeshDataTool.get_face_vertex method description Improve MeshDataTool.get_face_vertex() method description Aug 28, 2023
@mateuseap mateuseap force-pushed the docs/meshDataToolClassReference branch from ff78f4b to d5548db Compare August 28, 2023 21:33
@akien-mga
Copy link
Member

I would also suggest rewording the commit message as we don't use this format usually. The title of this PR is a good match for our usual commit style (you can see other examples in git log).

@akien-mga akien-mga modified the milestones: 4.x, 4.2 Aug 28, 2023
@mateuseap mateuseap force-pushed the docs/meshDataToolClassReference branch from d5548db to 7833a0a Compare August 28, 2023 22:05
@mateuseap
Copy link
Contributor Author

I would also suggest rewording the commit message as we don't use this format usually. The title of this PR is a good match for our usual commit style (you can see other examples in git log).

@akien-mga thanks for this suggestion!

@mateuseap mateuseap force-pushed the docs/meshDataToolClassReference branch from 7833a0a to 169daea Compare August 28, 2023 22:06
Copy link
Member

@clayjohn clayjohn left a comment

Choose a reason for hiding this comment

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

The content looks great! Thank you

@clayjohn clayjohn added the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Aug 29, 2023
Improve MeshDataTool.get_face_vertex() method description and also add an example code.

Co-authored-by: Raul Santos <raulsntos@gmail.com>
@mateuseap mateuseap force-pushed the docs/meshDataToolClassReference branch from 169daea to adb0d0e Compare August 29, 2023 08:27
@mateuseap
Copy link
Contributor Author

@clayjohn the commit description wasn't looking good so I just adjusted it, sorry for the delay!

image

@akien-mga akien-mga merged commit c52c830 into godotengine:master Aug 29, 2023
@akien-mga
Copy link
Member

Thanks!

@mateuseap mateuseap deleted the docs/meshDataToolClassReference branch August 29, 2023 10:59
@YuriSizov YuriSizov removed the cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release label Oct 24, 2023
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.1.3.

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.

MeshDataTool.get_face_vertex() has a unclear description.
6 participants