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

Clean up English in JSON documentation #95041

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

AdamLearns
Copy link
Contributor

This change only improves the wording and grammar used on this page. I originally only wanted to fix a typo, but I ended up proof-reading the whole page, and at least one function should be clearer as a result.

Note that I did not update any translation files:

╰─❯ rg "enables all data"
doc/translations/zh_TW.po
50968:"The [JSON] enables all data types to be converted to and from a JSON string. "

doc/translations/zh_CN.po
68886:"The [JSON] enables all data types to be converted to and from a JSON string. "

...should something be done with those?

@AdamLearns AdamLearns requested a review from a team as a code owner August 1, 2024 22:35
@Calinou Calinou added enhancement documentation cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Aug 1, 2024
@Calinou Calinou added this to the 4.3 milestone Aug 1, 2024
@Calinou
Copy link
Member

Calinou commented Aug 1, 2024

Note that I did not update any translation files:
...should something be done with those?

You don't need to do anything here, since they are updated automatically by maintainers on a regular basis.

doc/classes/JSON.xml Outdated Show resolved Hide resolved
@AdamLearns
Copy link
Contributor Author

AdamLearns commented Aug 2, 2024

Is there an easy way to see the resulting page that I've modified before committing? It didn't seem to be part of building Godot, and I wasn't positive based on the instructions here if I just need to look at individual pages using Sphinx/reST.

Sorry, this was answered as soon as I made the comment 🤦‍♂️: https://docs.godotengine.org/en/stable/contributing/documentation/building_the_manual.html

@mhilbrunner
Copy link
Member

Thanks for contributing :) The commits need to be squashed into one before this can be merged. See here for one explanation on how to do do that.

Otherwise, the changes themselves look good to me.

@akien-mga akien-mga merged commit d798b7a into godotengine:master Aug 6, 2024
18 checks passed
@akien-mga
Copy link
Member

Thanks!

@AdamLearns
Copy link
Contributor Author

Ah, sorry, Tuesdays and Thursdays are my catch-up days, so I didn't have a chance to look at this until now. I see that it's already been merged though—thank you for including the work! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants