-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Overhaul NodePath documentation #80183
Conversation
f672482
to
3def88b
Compare
3def88b
to
d44e523
Compare
^"/root/Title" # May point to the main scene's root node named "Title". | ||
^"/root/Global" # May point to an autoloaded node or scene named "Global". |
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.
Idk about using two examples here. Both could be either.
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 trimming it to a single example that proposes both possible nodes, but the example does look "uglier" and not as tidy as a result.
Another note, we could mention that "..", "." also count as names. |
d44e523
to
4848c71
Compare
Updated PR to address the majority of the review above, along with several tweaks especially to the leading description.
Both I feel like more can be done (namely, the short description absolutely needs to change), but it currently is in a pretty good state. |
4848c71
to
411b060
Compare
Very minor rebase after conflict. |
411b060
to
cd2ec6f
Compare
Rebased to force the Linux test to start, hopefully without bugging out. |
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.
Otherwise the language and style looks good
cd2ec6f
to
ab727a9
Compare
Accepted all of the above suggestions. Thank you. |
ab727a9
to
63319b6
Compare
Rebased after a "conflict" (it didn't really matter, it is overridden entirely). It would be nice to have this for 4.3 along with the other "polishing" changes. |
63319b6
to
78574dd
Compare
Thanks! |
At long last, thank you. A few of these long-standing ones shall remain. |
Currently a draft because it feels like more can still be done. I would love your assistance!Continuation of similar past efforts with the same goal of refreshing the documentation up a notch.
... Man, this doc has been collecting so much dust!
General
^""
) whenever applicable.-
Path2D/PathFollow2D/Sprite2D:texture:load_path
. Butload_path
isn't even a real thing.- There also were a lot of Path2D and PathFollow2D everywhere.
An outstandingly baffling choice for a class that is literally a path.
Constructors
NodePath(String)
"."
and".."
indicate the current node and its parent." is a bit misleading, too.You may use
..
in the middle an absolute path just fine if you really, really wanted toMethods
get_as_property_path
get_concatenated_names
,get_concatenated_subnames
get_name
,get_subname
hash
is_absolute
is_empty
true
if the node path is empty.". Wow, thanks!Feedback is very, very welcome.