Add missing helptext to lua attributes#27
Merged
Conversation
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>
Contributor
There was a problem hiding this comment.
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.pyto includelua:attributein the directive regex pattern and updated the docstring accordingly. - Added
.. helptext::directives to alllua:attributeentries 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.
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>
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: 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>
simsaens
reviewed
Mar 16, 2026
simsaens
approved these changes
Mar 16, 2026
Corrects type of `delta` attribute
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.