-
-
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
Standardize all "Prints" comments in documentation #99876
base: master
Are you sure you want to change the base?
Conversation
1a67266
to
6b35fd1
Compare
Given the mentioned PRs fall under a similar umbrella, and this is already a niche change, I'd recommend consolidating all of them into this PR |
6b35fd1
to
dab4a5c
Compare
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.
The changes to prints do seem to match the standards laid out in the OP. The other improvements made along the way generally look okay to me.
dab4a5c
to
1fb50ad
Compare
@@ -849,11 +849,11 @@ | |||
[codeblocks] | |||
[gdscript] | |||
var a = [1, 2, 3] | |||
print("a", "b", a) # Prints ab[1, 2, 3] | |||
print("a", "b", a) # Prints "ab[1, 2, 3]" |
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.
Looking at this example specifically, I wonder if a policy that is to use quotes for strings but not for number types is the right one.
What gets printed is:
ab[1, 2, 3]
which doesn't differ much from the output of print(42)
or print("ab[1, 2, 3]")
.
var a = [1, 2, 3]
print("a", "b", a)
print("ab[1, 2, 3]")
print(42)
prints:
ab[1, 2, 3]
ab[1, 2, 3]
42
So maybe we should use quotes all the time and not just for strings?
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'll leave that up for you or someone else to decide. Doing this is bikeshedding a bit and would be a whole lot more lines to change, but I do not mind doing it so long as it's consistent.
Related to
This PR tries to standardize the common
# Prints
comment present in a lot of the class reference. This is based off of a few rules, which are taken from my own written attempt to "explain myself":This PR is still a draft because these rules are still not consistent.As of writing this, not many additional changes are done to the affected descriptions.
Note that, in the grand scheme of things, this is an extremely minor change. Approve and merge this PR only if you feel like this is worth the localization needing to be refreshed.