1308572 - [jsdbg2] JavaScript Debugger API documentation includes unimplemented features

Status: VERIFIED FIXED

(Core :: JavaScript Engine, defect)

Description

[Jim Blandy :jimb]

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.

Comment 1

[Jim Blandy :jimb]

Attachment: Remove unimplemented Debugger.Environment features from docs.

Comment 2

[Jim Blandy :jimb]

Attachment: Remove references to generator special treatment from JS Debugger API docs.

Comment 3

[Jim Blandy :jimb]

Attachment: Remove references to watchpoints from JS Debugger API docs.

Comment 4

[Jim Blandy :jimb]

Attachment: Remove unimplemented Debugger.Source features from JS Debugger API docs.

Comment 5

[Jim Blandy :jimb]

Attachment: Remove unimplemented Debugger.Script features from JS Debugger API docs.

Comment 6

[Jason Orendorff [: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 :)

Comment 7

[Jason Orendorff [:jorendorff]]

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. :-\

Comment 8

[Jim Blandy :jimb]

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

Comment 9

[Pulsebot]

Pushed by [e-mail]:
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

Comment 10

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/4c17e2d68479
https://hg.mozilla.org/mozilla-central/rev/2c060e2559a2
https://hg.mozilla.org/mozilla-central/rev/2426d3b9f4d2
https://hg.mozilla.org/mozilla-central/rev/0b14f8ef6741
https://hg.mozilla.org/mozilla-central/rev/b7302a1af4fc

Comment 11

[Sebastian Zartner [:sebo]]

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

Comment 12

[Jim Blandy :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!

Comment 13

[Sebastian Zartner [:sebo]]

Yes, it's updated now. :-) Thank you again!

Sebastian