Closed Bug 1308572 Opened 3 years ago Closed 3 years ago

[jsdbg2] JavaScript Debugger API documentation includes unimplemented features

Categories

(Core :: JavaScript Engine, defect)

defect
Not set

Tracking

()

VERIFIED FIXED
mozilla52
Tracking Status
firefox52 --- fixed

People

(Reporter: jimb, Assigned: jimb)

References

Details

Attachments

(5 files)

The documentation for SpiderMonkey's Debugger API includes a lot of things that aren't actually implemented. We have better ways to handle future plans or nice-to-have features, like enhancement bugs, and it's confusing to have stuff in there that doesn't exist.
Blocks: 725814
Assignee: nobody → jimb
Status: NEW → ASSIGNED
Attachment #8798975 - Flags: review?(jorendorff)
Comment on attachment 8798975 [details] [diff] [review]
Remove unimplemented Debugger.Environment features from docs.

Review of attachment 8798975 [details] [diff] [review]:
-----------------------------------------------------------------

Shame about `eval`, I liked that idea :)
Attachment #8798975 - Flags: review?(jorendorff) → review+
Comment on attachment 8798980 [details] [diff] [review]
Remove references to generator special treatment from JS Debugger API docs.

Review of attachment 8798980 [details] [diff] [review]:
-----------------------------------------------------------------

My only quibble here is that it would be better to document the status quo, right? Otherwise the documentation is seriously incomplete. :-\
Attachment #8798980 - Flags: review?(jorendorff) → review+
Attachment #8798984 - Flags: review?(jorendorff) → review+
Attachment #8799004 - Flags: review?(jorendorff) → review+
Attachment #8799005 - Flags: review?(jorendorff) → review+
(In reply to Jason Orendorff [:jorendorff] from comment #7)
> Comment on attachment 8798980 [details] [diff] [review]
> Remove references to generator special treatment from JS Debugger API docs.
> 
> Review of attachment 8798980 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> My only quibble here is that it would be better to document the status quo,
> right? Otherwise the documentation is seriously incomplete. :-\

I don't think we do anything special with generators at all. We treat every resurrection of a generator as a separate frame, right? The only support we have is the `generator` accessor, which I left in.
Keywords: checkin-needed
Pushed by cbook@mozilla.com:
https://hg.mozilla.org/integration/mozilla-inbound/rev/4c17e2d68479
Remove unimplemented Debugger.Environment features from docs. r=jorendorff
https://hg.mozilla.org/integration/mozilla-inbound/rev/2c060e2559a2
Remove references to generator special treatment from JS Debugger API docs. r=jorendorff
https://hg.mozilla.org/integration/mozilla-inbound/rev/2426d3b9f4d2
Remove references to watchpoints from JS Debugger API docs. r=jorendorff
https://hg.mozilla.org/integration/mozilla-inbound/rev/0b14f8ef6741
Remove unimplemented Debugger.Source features from JS Debugger API docs. r=jorendorff
https://hg.mozilla.org/integration/mozilla-inbound/rev/b7302a1af4fc
Remove unimplemented Debugger.Script features from JS Debugger API docs. r=jorendorff
Keywords: checkin-needed
Thank you for the fix!

Unfortunately I don't see the changes pushed to https://developer.mozilla.org/en-US/docs/Tools/Debugger-API/Debugger.Environment yet. Will that be auto-updated or does that require a manual action?

Sebastian
Flags: needinfo?(jimb)
It requires that I run a script. Now that the fixes are landed, I've run the script, and MDN should be updated now.

Thanks for the ping!
Flags: needinfo?(jimb)
Yes, it's updated now. :-) Thank you again!

Sebastian
Status: RESOLVED → VERIFIED
You need to log in before you can comment on or make changes to this bug.