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

Standardize all "Prints" comments in documentation #99876

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Nov 30, 2024

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":

  • Where appropriate, use the following common inline comments:
    • # Prints {value}: After a print call. (or similar).
      Suitable for beginner topics, where you want the user to see the result upon copying and pasting the code sample. {value} should be formatted exactly how it would be printed to the console. No trailing period.
    • Do not encompass in quotes, unless a single String/StringName is the argument for print.
    • Encompass everything in quotes, when multiple arguments in the same print are used.

This PR is still a draft because these rules are still not consistent.


As of writing this, no 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.

@Mickeon Mickeon force-pushed the documentation-prints-obsession branch from 1a67266 to 6b35fd1 Compare November 30, 2024 14:57
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.

1 participant