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

Rewrite docs for physics damping project settings #82950

Merged

Conversation

thygrrr
Copy link
Contributor

@thygrrr thygrrr commented Oct 7, 2023

Correct location for the documentation changes I erroneously submitted to sphinx.
Resolves godotengine/godot-docs#8163
Supersedes godotengine/godot-docs#8176

Physics Damping (2D and 3D) documentation was incorrect and misleading, suggesting a critical spring damping scheme (that "tries to stop a body in a given time", but it's a "negative exponential damper", that is both velocity and tick-rate dependent).

Hopefully this will save some hairs from going grey and provide a deeper understanding for the users of this obscure value and its inner workings (Godot is a bit special in this regard, though the combine feature is really cool) :)

doc/classes/ProjectSettings.xml Outdated Show resolved Hide resolved
doc/classes/ProjectSettings.xml Outdated Show resolved Hide resolved
@thygrrr
Copy link
Contributor Author

thygrrr commented Oct 12, 2023

I don't understand the concrete failure in
GHA / 🐧 Linux / Editor w/ Mono (target=editor) (pull_request)

@AThousandShips
Copy link
Member

Follow my corrections above, you have a format error

Copy link
Contributor

@Mickeon Mickeon left a comment

Choose a reason for hiding this comment

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

This looks like a great exahustive explanation, the opposite of what it was before. Would be nice to have merged sooner than later.

@akien-mga akien-mga requested a review from a team January 16, 2024 16:59
@Mickeon
Copy link
Contributor

Mickeon commented Jan 26, 2024

If you can squash those commits it would be very nice. See https://docs.godotengine.org/en/stable/contributing/workflow/pr_workflow.html#the-interactive-rebase

@akien-mga akien-mga changed the title Physics damping Redocumentation Physics damping documentation rewrite Jan 29, 2024
Signed-off-by: Tiger Jove <tiger@jupiter.blue>
@akien-mga akien-mga force-pushed the physics-damping-redocumentation branch from d3a5cc4 to 7d9f6da Compare February 9, 2024 17:01
@akien-mga
Copy link
Member

I squashed the commits, and fixed trailing spaces and the use of Windows return carriage at end of lines.

@akien-mga akien-mga modified the milestones: 4.x, 4.3 Feb 9, 2024
@akien-mga akien-mga changed the title Physics damping documentation rewrite Rewrite docs for physics damping project settings Feb 9, 2024
@akien-mga akien-mga merged commit b604a05 into godotengine:master Feb 9, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks! And congrats for your first merged Godot contribution 🎉

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.

Damping for 2D and 3D is described incorrectly.
5 participants