creator-docs icon indicating copy to clipboard operation
creator-docs copied to clipboard

Removed duplicates of debug.info()

Open ExtremePro11299 opened this issue 9 months ago • 1 comments

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:

  • [x] 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.
  • [x] 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.
  • [x] To the best of my knowledge, all proposed changes are accurate.

ExtremePro11299 avatar Apr 26 '25 08:04 ExtremePro11299

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.

IgnisRBX avatar Apr 28 '25 18:04 IgnisRBX

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[bot] avatar May 12 '25 20:05 github-actions[bot]

Anti-stale comment

ExtremePro11299 avatar May 14 '25 17:05 ExtremePro11299

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 avatar May 22 '25 21:05 IgnisRBX

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 avatar Jun 02 '25 22:06 tchu-roblox

Uploading Screenshot_20250901-024649_Roblox.jpg…

qandmsurplus-lab avatar Sep 01 '25 18:09 qandmsurplus-lab