From 449b21c8c812a0b418a80d68cb6cb73908eb7cee Mon Sep 17 00:00:00 2001 From: carraka Date: Fri, 26 Sep 2025 07:01:13 -0400 Subject: [PATCH 1/2] Update to guidelines on progressive forms - I couldn't find an example with "replacing" so I assumed "stopping" was meant. - Moved "Exception:" down to where there is an exception. - Tightened up language about participle adjectives. It's unclear to me whether there's a character limit per line. I kept to under 80 characters. Thank you for your review. I wanted to do something simple for my first pull request, so please let me know how I can improve my process before I venture into open documentation issues. --- .../guidelines/docs_writing_guidelines.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/documentation/guidelines/docs_writing_guidelines.rst b/documentation/guidelines/docs_writing_guidelines.rst index 61955f2..03c8f7f 100644 --- a/documentation/guidelines/docs_writing_guidelines.rst +++ b/documentation/guidelines/docs_writing_guidelines.rst @@ -119,18 +119,18 @@ The progressive forms describe continuous actions. E.g. "is calling", Vector2 move ( Vector2 rel_vec ) Moves the body in the vector's direction. The body **stops** if it collides with an obstacle. [...] -Exception: If the subject is not clear, replacing "ing" verbs is not an -improvement. For example, in the previous sentence, "it replaces" -would not make much sense where "replacing" currently is. +If the subject is not clear, replacing the "ing" verb is not an automatic +improvement. For example, in the above **Don't** sentence, "it stops" +would not make much sense where "stopping" currently is. -You may use the progressive tense to describe actions that are -continuous in time. Anything like animation or coroutines. +Exception: You may use the progressive tense to describe actions such as +animations or coroutines that are continuous in time. .. tip:: - Verbs can turn into adjectival nouns with -ing. This is not a - conjugation, so you may use them: ``the remaining movement``, - ``the missing file``, etc. + Adding -ing at the end of a verb can turn a noun into an adjective. + These -ing words are not an example of progressive form, and you may + use them: ``the remaining movement``, ``the missing file``, etc. Remove unnecessary adverbs and adjectives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 6922c62aeacaaeb14c4982d84a977f7f71985eb6 Mon Sep 17 00:00:00 2001 From: carraka Date: Fri, 26 Sep 2025 07:12:25 -0400 Subject: [PATCH 2/2] Slight tweak to improve clarity Should have kept examples at the end to keep relevant text together. --- documentation/guidelines/docs_writing_guidelines.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/guidelines/docs_writing_guidelines.rst b/documentation/guidelines/docs_writing_guidelines.rst index 03c8f7f..8d39dd4 100644 --- a/documentation/guidelines/docs_writing_guidelines.rst +++ b/documentation/guidelines/docs_writing_guidelines.rst @@ -123,8 +123,8 @@ If the subject is not clear, replacing the "ing" verb is not an automatic improvement. For example, in the above **Don't** sentence, "it stops" would not make much sense where "stopping" currently is. -Exception: You may use the progressive tense to describe actions such as -animations or coroutines that are continuous in time. +Exception: You may use the progressive tense to describe actions that are +continuous in time, such as animations or coroutines. .. tip::