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

Simply remove some words #10409

Merged
merged 1 commit into from
Dec 15, 2024
Merged

Conversation

tetrapod00
Copy link
Contributor

Do we still believe in banning these words? If so, these are the usages of "simply" that I could find that are unambiguously in the spirit of the rule. They are cases where "simply" is an empty adverb, or where it trivializes the difficulty of learning something new. This includes most cases where the reader is instructed to "simply do something" with an imperative verb.

I left unchanged many examples of "simply" where it is a valid comparison against a more complex approach, or where it really is simple to do something in Godot, and this is worth remarking upon. I also left unchanged instances in outdated tutorials where I'm pretty sure the whole page needs to be rewritten.

To justify the changes, I made additional improvements to changed lines where I could find them. (But translations break at the paragraph level, so maybe I should do a second pass on the changed paragraphs instead?)

@tetrapod00 tetrapod00 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation area:contributing Issues and PRs related to the Contributing/Development section of the documentation content:proofreading Issues and PRs related to proofreading the documentation labels Dec 15, 2024
@@ -100,7 +100,7 @@ like ``core/math/a_star_grid_2d.compat.inc`` in this case:

#endif // DISABLE_DEPRECATED

Unless the change in compatibility is complex, the compatibility method should simply call the modified method directly,
Unless the change in compatibility is complex, the compatibility method should call the modified method directly,
Copy link
Member

@mhilbrunner mhilbrunner Dec 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd argue this one is not in the spirit of the rule, as the meaning here does not seem to be "this is obvious and/or simple to you, reader", but rather "the compat method should do a simple (as in direct) call in this case, instead of something more involved".

However, I also don't think it hurts to remove it, as the sentence is just as clear without it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rule also covers empty adverbs like this!

I'd argue that if the reader should directly call the method, you could use the world "directly" instead of "simply" here.

@mhilbrunner
Copy link
Member

mhilbrunner commented Dec 15, 2024

Do we still believe in banning these words?

While I'm not sure I'm in favor of it being a hard rule, this improving all these sentences IMO shows that it is a good rule, if maybe not one that should be applied 100% in all cases. :)

Thanks!

@mhilbrunner mhilbrunner merged commit 8c18786 into godotengine:master Dec 15, 2024
1 check passed
@tetrapod00 tetrapod00 deleted the no-simply branch December 15, 2024 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation area:manual Issues and PRs related to the Manual/Tutorials section of the documentation content:proofreading Issues and PRs related to proofreading the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants