Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions documentation/guidelines/docs_writing_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 that are
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Exception: You may use the progressive tense to describe actions that are
Exception: You may use the progressive tense to describe actions that are

continuous in time, such as animations or coroutines.

.. 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
These -ing words are not an example of progressive form, and you may
These -ing words are not an example of progressive form, and you may

Copy link
Member

@Mickeon Mickeon Sep 30, 2025

Choose a reason for hiding this comment

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

Oh, we... could use some static checks for trailing spaces.

Copy link
Member

Choose a reason for hiding this comment

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

Right, this repo currently doesn't have any static checks. I'll make a note to see if I can copy anything from the docs repo.

use them: ``the remaining movement``, ``the missing file``, etc.

Remove unnecessary adverbs and adjectives
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down