Skip to content

Add missing helptext to lua attributes#27

Merged
jfperusse merged 44 commits intomainfrom
fix/attribute-helptext
Mar 16, 2026
Merged

Add missing helptext to lua attributes#27
jfperusse merged 44 commits intomainfrom
fix/attribute-helptext

Conversation

@jfperusse
Copy link
Collaborator

No description provided.

jfperusse and others added 19 commits March 16, 2026 06:36
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds missing .. helptext:: directives to lua:attribute documentation entries across the RST API docs, and updates the check_helptexts.py script to also validate lua:attribute directives (previously only lua:function, lua:method, and lua:staticmethod were checked).

Changes:

  • Extended check_helptexts.py to include lua:attribute in the directive regex pattern and updated the docstring accordingly.
  • Added .. helptext:: directives to all lua:attribute entries across 14 RST documentation files.
  • Many helptexts appear to have been auto-generated or copied from unrelated contexts, resulting in numerous incorrect/misleading descriptions.

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 22 comments.

Show a summary per file
File Description
scripts/check_helptexts.py Added attribute to the directive regex so the check script validates helptext on lua:attribute directives
docs/source/api/ui.rst Added helptexts to canvas, label, image, button, vstack, hstack attributes
docs/source/api/tween.rst Added helptexts to tween duration, progress, target attributes
docs/source/api/style.rst Added helptexts to shape mode, blend mode, blend function/factor, stencil, text, style, render queue, color mask, culling, and depth constants
docs/source/api/sound.rst Added helptexts to sound preset constants
docs/source/api/shader.rst Added helptext to shader buffer size attribute
docs/source/api/require.rst Added helptext to require options attribute
docs/source/api/pick.rst Added helptext to pick options attribute
docs/source/api/physics3d.rst Added helptexts to 3D physics body, rayHit, and world attributes
docs/source/api/physics2d.rst Added helptexts to 2D physics body, collider, contact, rayHit, joint, and shape attributes
docs/source/api/pasteboard.rst Added helptexts to pasteboard attributes
docs/source/api/motion.rst Added helptexts to motion reference frame and magnetic field attributes
docs/source/api/mesh.rst Added helptexts to mesh attributes (texture, shader, vertices, etc.)
docs/source/api/math_types.rst Added helptexts to vec2/vec3/vec4/quat component and length attributes
docs/source/api/light.rst Added helptexts to light and shadow option attributes
docs/source/api/input.rst Added helptexts to touch, gesture, keyboard key, and gamepad attributes
docs/source/api/image.rst Added helptexts to image, sampler state, and slice/atlas attributes
docs/source/api/entity.rst Added helptexts to entity attributes (transform, lifecycle, physics, UI, etc.)
docs/source/api/color.rst Added helptexts to color component and preset constant attributes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link
Collaborator Author

@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.

See comments.

jfperusse and others added 7 commits March 16, 2026 07:55
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jfperusse and others added 9 commits March 16, 2026 07:57
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@jfperusse jfperusse requested review from Copilot and removed request for Copilot March 16, 2026 12:02
jfperusse and others added 8 commits March 16, 2026 08:03
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Co-authored-by: Jean-François Pérusse <jfperusse@gmail.com>
Removed duplicate touchpadSurface attribute documentation.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@jfperusse jfperusse requested a review from simsaens March 16, 2026 12:09
Corrects type of `delta` attribute
@jfperusse jfperusse merged commit 28d6ea0 into main Mar 16, 2026
1 check passed
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.

3 participants