Skip to content

Added Animation, Tilemaps, and many more#24

Open
Lioncub901 wants to merge 22 commits into
twolivesleft:mainfrom
Lioncub901:main
Open

Added Animation, Tilemaps, and many more#24
Lioncub901 wants to merge 22 commits into
twolivesleft:mainfrom
Lioncub901:main

Conversation

@Lioncub901
Copy link
Copy Markdown
Contributor

No description provided.

@jfperusse
Copy link
Copy Markdown
Collaborator

Hey @Lioncub901, sorry for the conflicts, we did a pass to add helptext to every method, attribute, etc. Your conflicts will have to be resolved and missing helptext should be added. Thanks!

Copy link
Copy Markdown
Collaborator

@jfperusse jfperusse left a comment

Choose a reason for hiding this comment

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

General comment:

  • Careful with the typos and missing words. Please do a pass on grammar before sending for review. Missing words sometimes makes it confusing.
  • Please standardize between "keyframe" or "key frame". I'm not going to list all of them but we should use one, not both. I prefer "keyframe".
  • Try to use full sentences, and be consistent with how you end the types descriptions. Right now, they sometimes end with a dot, sometimes not. I'm not going to list all of them either.
  • Make sure helptext is added to ALL lua:method / lua:staticmethod / lua:attribute. There is a python script under the scripts folder you can use to list all missing ones.
  • As I was nearing 100 comments, I skipped quickly over timemap and time files. Please review them based on my other comments as well.

Comment thread docs/source/api/animation.rst Outdated
Comment thread docs/source/api/animation.rst Outdated
Comment thread docs/source/api/animation.rst Outdated
Comment thread docs/source/api/animation.rst Outdated
Comment thread docs/source/api/animation.rst Outdated
Comment thread docs/source/api/tilemap.rst Outdated
Comment thread docs/source/api/tilemap.rst Outdated
Comment thread docs/source/api/tilemap.rst Outdated
Comment thread docs/source/api/tilemap.rst Outdated
Comment thread docs/source/api/tilemap.rst
Copy link
Copy Markdown
Collaborator

@jfperusse jfperusse left a comment

Choose a reason for hiding this comment

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

General comment:

  • Careful with the typos and missing words. Please do a pass on grammar before sending for review. Missing words sometimes makes it confusing.
  • Please standardize between "keyframe" or "key frame". I'm not going to list all of them but we should use one, not both. I prefer "keyframe".
  • Try to use full sentences, and be consistent with how you end the types descriptions. Right now, they sometimes end with a dot, sometimes not. I'm not going to list all of them either.
  • Make sure helptext is added to ALL lua:method / lua:staticmethod / lua:attribute. There is a python script under the scripts folder you can use to list all missing ones.
  • As I was nearing 100 comments, I skipped quickly over timemap and time files. Please review them based on my other comments as well.

Lioncub901 and others added 18 commits March 29, 2026 20:37
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
@Lioncub901 Lioncub901 requested a review from jfperusse April 10, 2026 12:10
Copy link
Copy Markdown
Collaborator

@jfperusse jfperusse left a comment

Choose a reason for hiding this comment

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

A few remaining comments. Note that I did not go through every single helptext added, and one of them was a copy/paste not documenting the right element (I added a comment for it), so please double check that your added helptext are all correct. Thank you!


.. lua:attribute:: fps: integer

The frames that are placed pre second
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Lioncub901 You don't see to have addressed this one.


Gets the tracks of the animation

.. helptext:: checks if the animation is playing
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Wrong helptext.

Comment thread docs/source/api/animation.rst Outdated

.. lua:attribute:: count: integer

The amount of keyframes in a track
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Lioncub901 Please search and replace any "key frame" to "keyframe".

Comment thread docs/source/api/input.rst Outdated

Enables/disables this gesture recognizer

.. helptext:: whether the gesture recognizer is enabled
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Look for other places where you have "whether the gesture recognizer is enabled" and standardize to "get or set if the gesture recognizer is enabled"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants