Docs: Add cross-links to antialiasing project settings #96893
Merged
+22
−13
Conversation
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
skyace65
approved these changes
Oct 12, 2024
|
Confirmed links lead to the right place |
clayjohn
approved these changes
Oct 17, 2024
clayjohn
added
the
cherrypick:4.3
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First PR for godotengine/godot-docs#9944. Does not close that issue.
Adds three-way cross-links between the settings in
ProjectSettings.anti_aliasingand the relevant runtime equivalents on Viewport and RenderingServer.This is the first PR of multiple, aiming to consistently cross-link between the project settings and the runtime equivalents of each setting. Please review this PR knowing that it will set some precedent for future work. Feel free to nitpick phrasing. I chose antialiasing settings to start because it's a small section and I'm familiar with it. I can do work in larger chunks in the future if it makes reviews easier.
Standardizes style, using "antialiasing" instead of "anti-aliasing", "runtime" instead of "run-time". Antialiasing methods are lowercase, not title case. Some other small changes are made, but I did not try to majorly rewrite the descriptions, or verify correctness of the information already present. If more extensive changes are desired to justify breaking translations, I can do that too.
For cross-link phrasing, I matched existing phrasing on each page. It's not necessarily what I would have written from scratch, but it keeps consistency.
ProjectSettings.xml:
[b]Note:[/b] This property is only read when the project starts. To set TAA at runtime, set [member Viewport.use_taa] on the root [Viewport] instead, or use [method RenderingServer.viewport_set_use_taa].Viewport.xml:
See also [member ProjectSettings.rendering/anti_aliasing/quality/use_taa] and [method RenderingServer.viewport_set_use_taa].RenderingServer.xml:
Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/use_taa] or [member Viewport.use_taa].I chose three-way cross-linking as a starting point. There might be some argument for not cross-linking this extensively. Maybe we should not direct users to the RenderingServer unless there is no duplicate method in a more friendly class like Viewport?