Anoher clean-up for chrome.experimental.devtools.* docs

Anoher clean-up for chrome.experimental.devtools.* docs

- marked most callbacks as optional;
- merged PanelWithSidebars into ElementsPanel;
- more specific description for most of the callbacks;
- misc puntuation fixes;^H.

BUG=none
TEST=none


Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=110485

[caseq, 2011-11-11 11:00:53]

This is a bunch of fixes in the devtools_api.json based on Meggin's feedback.

Live version is here:
http://www.corp.google.com/~caseq/devtoolsext/docs/experimental.devtools.html

A couple of notes:
- I did not mark callbacks for getSomething() methods as optional, although in
fact they are. This would just look silly for getters, in my opinion;
- the calllbacks that may return error still have a generic description of
"called upon request completion".

[mkearney, 2011-11-11 19:08:22]

Can you sync your client to bring my changes into your changes and then
send on a new live version?

That way I can do a full sweep of the latest.

Thanks,

Meggin

On Fri, Nov 11, 2011 at 3:00 AM, <caseq@chromium.org> wrote:

> Reviewers: mkearney, Kathy Walrath,
>
> Message:
> This is a bunch of fixes in the devtools_api.json based on Meggin's
> feedback.
>
> Live version is here:
> http://www.corp.google.com/~**caseq/devtoolsext/docs/**
>
experimental.devtools.html<http://www.corp.google.com/~caseq/devtoolsext/docs/experimental.devtools.html>
>
> A couple of notes:
> - I did not mark callbacks for getSomething() methods as optional,
> although in
> fact they are. This would just look silly for getters, in my opinion;
> - the calllbacks that may return error still have a generic description of
> "called upon request completion".
>
>
> Description:
> Anoher clean-up for chrome.experimental.devtools.* docs
>
> - marked most callbacks as optional;
> - merged PanelWithSidebars into ElementsPanel;
> - more specific description for most of the callbacks;
> - misc puntuation fixes;^H.
>
> BUG=none
> TEST=none
>
>
> Please review this at
http://codereview.chromium.**org/8538005/<http://codereview.chromium.org/8538...
>
> SVN Base:
svn://svn.chromium.org/chrome/**trunk/src<http://svn.chromium.org/chrome/trunk/src>
>
> Affected files:
>  M chrome/common/extensions/api/**devtools_api.json
>  M chrome/common/extensions/docs/**experimental.devtools.console.**html
>  M chrome/common/extensions/docs/**experimental.devtools.**
> inspectedWindow.html
>  M chrome/common/extensions/docs/**experimental.devtools.network.**html
>  M chrome/common/extensions/docs/**experimental.devtools.panels.**html
>
>
>

[caseq, 2011-11-14 16:04:51]

On 2011/11/11 19:08:22, mkearney wrote:
> Can you sync your client to bring my changes into your changes and then
> send on a new live version?
> 
> That way I can do a full sweep of the latest.

Rebased the patch to the tip of tree.

I'm also looking to make another change there -- drop Panel and move
onHide/onShow events to ExtensionPanel and ExtensionSidebarPane. The
corresponding code change is not yet landed in WebKit, though, so I'm not doing
this right now.

[mkearney, 2011-11-14 16:38:14]

Sounds good.

When you are ready for the next review, just let me know.

Also, can you send on a live version?

Thanks,

Meggin

On Mon, Nov 14, 2011 at 8:04 AM, <caseq@chromium.org> wrote:

> On 2011/11/11 19:08:22, mkearney wrote:
>
>> Can you sync your client to bring my changes into your changes and then
>> send on a new live version?
>>
>
>  That way I can do a full sweep of the latest.
>>
>
> Rebased the patch to the tip of tree.
>
> I'm also looking to make another change there -- drop Panel and move
> onHide/onShow events to ExtensionPanel and ExtensionSidebarPane. The
> corresponding code change is not yet landed in WebKit, though, so I'm not
> doing
> this right now.
>
>
>
http://codereview.chromium.**org/8538005/<http://codereview.chromium.org/8538...
>

[caseq, 2011-11-14 17:24:36]

On 2011/11/14 16:38:14, mkearney wrote:
> When you are ready for the next review, just let me know.
> 
> Also, can you send on a live version?

We've done with the onShown/onHidden change as well (thought the WebKit change
will take a bit longer to land).
The live version is here:
http://www.corp.google.com/~caseq/devtoolsext/docs/experimental.devtools.html

[mkearney, 2011-11-14 18:15:35]

Hey,

The changes that I put through are still not showing up with your changes.

For example, here is what the inspectedWindow looks in trunk which includes
my changes:
http://code.google.com/chrome/extensions/trunk/experimental.devtools.inspecte...
.

Hopefully this just requires another gclient sync.

Meggin

On Mon, Nov 14, 2011 at 9:24 AM, <caseq@chromium.org> wrote:

> On 2011/11/14 16:38:14, mkearney wrote:
>
>> When you are ready for the next review, just let me know.
>>
>
>  Also, can you send on a live version?
>>
>
> We've done with the onShown/onHidden change as well (thought the WebKit
> change
> will take a bit longer to land).
> The live version is here:
> http://www.corp.google.com/~**caseq/devtoolsext/docs/**
>
experimental.devtools.html<http://www.corp.google.com/~caseq/devtoolsext/docs/experimental.devtools.html>
>
>
>
http://codereview.chromium.**org/8538005/<http://codereview.chromium.org/8538...
>

[caseq, 2011-11-15 09:30:54]

On 2011/11/14 18:15:35, mkearney wrote:
> Hey,
> 
> The changes that I put through are still not showing up with your changes.
> 
> For example, here is what the inspectedWindow looks in trunk which includes
> my changes:
>
http://code.google.com/chrome/extensions/trunk/experimental.devtools.inspecte...
> .
> 
> Hopefully this just requires another gclient sync.

Nope, it must be something stuck in cache on your end. I ran a diff between
trunk version and the one I uploaded to www.corp, and it only includes my latest
changes -- so your changes are already in.

Generally, you can get a live version of changes by applying the changes locally
in under a minute -- check out the Download raw patch set link on the right,
then do something like

curl http://codereview.chromium.org/download/issue8538005_8001.diff | patch -p1
&& chrome/common/extensions/docs/build/build.sh

while in chromium/src.

[mkearney, 2011-11-15 16:37:09]

Thanks, Andrey, for heads up. I'm going to get help from Kathy this morning
to see what's up from my end.

Meggin

On Tue, Nov 15, 2011 at 1:30 AM, <caseq@chromium.org> wrote:

> On 2011/11/14 18:15:35, mkearney wrote:
>
>> Hey,
>>
>
>  The changes that I put through are still not showing up with your changes.
>>
>
>  For example, here is what the inspectedWindow looks in trunk which
>> includes
>> my changes:
>>
>
> http://code.google.com/chrome/**extensions/trunk/experimental.**
>
devtools.inspectedWindow.html<http://code.google.com/chrome/extensions/trunk/experimental.devtools.inspectedWindow.html>
>
>> .
>>
>
>  Hopefully this just requires another gclient sync.
>>
>
> Nope, it must be something stuck in cache on your end. I ran a diff between
> trunk version and the one I uploaded to www.corp, and it only includes my
> latest
> changes -- so your changes are already in.
>
> Generally, you can get a live version of changes by applying the changes
> locally
> in under a minute -- check out the Download raw patch set link on the
> right,
> then do something like
>
> curl
http://codereview.chromium.**org/download/issue8538005_**8001.diff<http://cod...
patch -p1
> && chrome/common/extensions/docs/**build/build.sh
>
> while in chromium/src.
>
>
>
http://codereview.chromium.**org/8538005/<http://codereview.chromium.org/8538...
>

[mkearney, 2011-11-15 20:09:12]

One small change - a missing full-stop.

http://codereview.chromium.org/8538005/diff/8001/chrome/common/extensions/doc...
File chrome/common/extensions/docs/experimental.devtools.panels.html (right):

http://codereview.chromium.org/8538005/diff/8001/chrome/common/extensions/doc...
chrome/common/extensions/docs/experimental.devtools.panels.html:1285:
<dd>Represents the Elements panel</dd>
Missing a full-stop here.

[caseq, 2011-11-16 17:33:04]

On 2011/11/15 20:09:12, mkearney wrote:
> One small change - a missing full-stop.

Fixed.

[kathyw, 2011-11-16 18:14:00]

lgtm

[commit-bot: I haz the power, 2011-11-17 09:35:01]

CQ is trying da patch. Follow status at
https://chromium-status.appspot.com/cq/caseq@chromium.org/8538005/16001

[commit-bot: I haz the power, 2011-11-17 10:56:33]

Change committed as 110485

[mkearney, 2011-11-17 17:18:33]

Cool.

On Thu, Nov 17, 2011 at 2:56 AM, <commit-bot@chromium.org> wrote:

> Change committed as 110485
>
>
http://codereview.chromium.**org/8538005/<http://codereview.chromium.org/8538...
>