Skip to content

Conversation

@ExtremePro11299
Copy link
Contributor

Changes

I ran into the debug.info() thing 3 times while scrolling. This should fix it. One of the duplicates had a different code sample that the other two, so I cut and pasted it into the one debug.info() that I made.

Checks

By submitting your pull request for review, you agree to the following:

  • This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
  • I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
  • To the best of my knowledge, all proposed changes are accurate.

@ExtremePro11299 ExtremePro11299 requested a review from a team as a code owner April 26, 2025 08:40
@github-actions github-actions bot added the engine reference Changes the Engine API Reference documentation label Apr 26, 2025
@IgnisRBX
Copy link
Contributor

Admitted that this is a bit unclear, but it's a factor of how library functions are output to docs. The three different "variations" of debug.info() are shown since they each expect a different set of parameters... note that it's either level, options OR function, options OR thread, level, options. So each of these is documented separately. Open to cleaning up aspects of each if necessary, but we'd prefer to keep all 3 variations.

@github-actions
Copy link

This pull request has been inactive for 14 days. If there's no activity in the next 7 days, it will be automatically closed. To keep it open, please comment or push new commits. Alternatively, add the label do-not-close to exempt it from auto-closing. 🫡 🙏

@github-actions github-actions bot added the stale label May 12, 2025
@ExtremePro11299
Copy link
Contributor Author

Anti-stale comment

@github-actions github-actions bot removed the stale label May 14, 2025
@IgnisRBX
Copy link
Contributor

How does this look? I basically consolidated the three debug.info() blocks into one, and noted that it can be done in three different ways. Did the same for the two debug.traceback() blocks as well.
image

@IgnisRBX IgnisRBX merged commit 4c02adc into Roblox:main Jun 2, 2025
3 checks passed
@tchu-roblox
Copy link
Member

Hi @ExtremePro11299, thank you for your contribution! I appreciate the effort to clean up duplicate entries — the intent makes perfect sense.

Unfortunately, we'll need to revert this change for now. The current system relies on those duplicates to render documentation for overloaded functions in the Script Editor. We know this isn't ideal, and we're looking into ways to improve how these duplicates are navigated and displayed on the docs site.

Thanks again for taking the time to improve the docs — we value your contributions!

tchu-roblox added a commit that referenced this pull request Jun 2, 2025
tchu-roblox added a commit that referenced this pull request Jun 2, 2025
Reverts #1085

The current system relies on those duplicates to render documentation
for overloaded functions in the Script Editor. We know this isn't ideal,
and we're looking into ways to improve how these duplicates are
navigated and displayed on the docs site.
@qandmsurplus-lab
Copy link

Uploading Screenshot_20250901-024649_Roblox.jpg…

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

Labels

engine reference Changes the Engine API Reference documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants