New API doc - typos and questions

Dan Rathbun

How about - when the issues from this thread has been addressed we lock and unstick it?

(I can move some posts around later on.)

I can move my suggestions over to the 'API WishList' thread. It seemed easier to voice them at the time I noticed the errors (I always added them after stating the errors in a different color.)

But I can understand how all the extra 'noise' makes using the thread as a checklist difficult for the GSUPT (Google Sketchup Product Team.)

cjthompson

The "View" documentation page is almost completely blocked by the user comments section:

EDIT: Fixed.

scottlininger

@dan rathbun said:

@unknownuser said:

As soon as we close out the issues in this thread, I will remove it from the forums.

Don't you dare!

All great points, Dan. There is a valuable historical record here, and there are a lot of posts that aren't simple docs corrections. No reason to remove it. More what I'm getting at is to make it clear where different kind of posts are best shared, as you said. This is the community's site, not mine, so ultimately it's the community's decision!

Cheers,

tomasz

@unknownuser said:

Model.select_tool
.....
Arguments:
tool - The Tool object you want to select.
**Returns:**
tool  - **A Tool object.** %(#FF0000)[False! It returns **Sketchup::Model**]

cjthompson

http://code.google.com/apis/sketchup/docs/ourdoc/face.html#classify_point

@unknownuser said:

The classify_point method is used to determine if a given Point3d is on your face. The return value will be from this list:

0: PointUnknown,
1: PointInside,
2: PointOnVertex,
4: PointOnEdge,
8: PointOnFace,
16: PointOutside

the list should be:
0: PointUnknown,
1: PointInside,
2: PointOnEdge,
4: PointOnVertex,
8: PointOnPlane,
16: PointOutside

thomthom

@cjthompson said:

http://code.google.com/apis/sketchup/docs/ourdoc/face.html#classify_point
the list should be:
0: PointUnknown,
1: PointInside,
2: PointOnEdge,
4: PointOnVertex,
8: PointOnPlane,
16: PointOutside

What?? ... I need to check some of my plugins...

Dan Rathbun

Model.get_product_family
http://code.google.com/apis/sketchup/docs/ourdoc/model.html#get_product_family

[url=http://forums.sketchucation.com/viewtopic.php?f=180&t=5868&p=236483#p35213:1wad19kf]This thread[/url:1wad19kf] gives a second-hand indication that Model.get_product_family is deprecated and "might be removed from the API at any time."

So the question(s) I have is:

Is it ( Model.get_product_family ) really to be considered as deprecated ??

And if so, should not the API doc (link above,) mention this ( and perhaps direct coders to use Sketchup.is_pro? instead ) ??

tomasz

@unknownuser said:

WebDialog.set_full_security=
The set_full_security= method is used to place the WebDialog into a higher security mode where remote URLs and plugins (such as Flash) are not allowed inside the browser. This defaults to false when a new WebDialog is created.

This method does not exist. There is set_full_security BUT It doesn't take arguments!! Also I am not sure if it defaults to false on MAC since it doesn't display Flash while under Windows it does.

Dan Rathbun

WebDialog.set_full_security
@unknownuser said:

@unknownuser said:

WebDialog.set_full_security=
The set_full_security= method is used to place the WebDialog into a higher security mode where remote URLs and plugins (such as Flash) are not allowed inside the browser. This defaults to false when a new WebDialog is created.

This method does not exist. There is set_full_security BUT It doesn't take arguments!! Also I am not sure if it defaults to false on MAC since it doesn't display Flash while under Windows it does.

Also the API code example has nothing to do with this method.

Dan Rathbun

REPOST: from Mon MAR 08, 2010
The web page has still not been fixed.
API - Release Notes webpage error
http://code.google.com/apis/sketchup/docs/releases.html

The H2 Heading "What's new in SketchUp 7" is not displayed as a H2 heading.

The error is caused by a missing '>' (greaterthan character) on the end of the preceeding <P> element closing tag, which is now: '</P'
ie, snippit from current HTML source (line 378):

` %(#804000)[<p class="post"> </p

<h2>What's new in SketchUp 7</h2>]`

"What's new in SketchUp 7" should be rendered the same as:
"What's new in SketchUp 7.0 M1"
Adding a screenshot:

Dan Rathbun

The above error on the API Release Notes webpage no longer applies since the release of Sketchup v8.0 ...

... because all mention of Maintainance Releases have been scrubbed from the page, including the fixes, functionality and new methods that were introduced by the MR.

Example (see above,) Sketchup 7.0MR1 added the get_glued_instances instance method to the Sketchup::Face class, but now readers (especially those new to using the SUAPI,) will not know this by looking at this page. They'd need to notice the version on the right, of the method defintion, on the Face class page. [ie: SketchUp 7.0.10247 (M1)+]

Did anyone save an offline archive of the API Release Notes Page ?? ( Can you attach copy to this thread if so, please. )

thomthom

sigh ... I only hope this is because of some restructure of the API site. Better poke a Googler just in case to make sure that info will be available somewhere.

Dan Rathbun

@thomthom said:

... just in case to make sure that info will be available somewhere.

Isn't there an web archive kept by Google somewhere.. built by bots ??

Dan Rathbun

@thomthom said:

I only hope this is because of some restructure of the API site.

I also. I'd like to see the page remade like the SU Application Release Notes page, with expanding sections for each release.

Dan Rathbun

@dan rathbun said:

@thomthom said:

... just in case to make sure that info will be available somewhere.

Isn't there an web archive kept by Google somewhere.. built by bots ??

Yes, found it (Google caches their own pages): Release Notes - Google SketchUp Ruby API - v7

Not knowing when this cached page will be replaced (possibly the 1st of next month,) here's an offline snapshot:
Release Notes - Google SketchUp Ruby API - v7.zip

snicolo

Guys, thanks for the heads up, you can blame this one on ScottL but also he was the one that corrected it, so I guess he is even.

Should be fixed shortly.
Simone.

thomthom

Just saw the updates.
Scott even sneaked in a UTM class - which apparently has been there since SU6??

tomot

WOW! no replies for almost a year! Things must really have improved on the SketchUp API side of things .......just kidding!
I noticed Google is buying Motorola or 12.5 Billion today http://www.telegraph.co.uk/technology/google/8702132/Google-buys-Motorola-Mobility-in-12.5bn-deal.html

Looks like they ran out of money once again, still can't afford to hire someone to get rid of the typos in the API.

scottlininger

@tomot said:

WOW! no replies for almost a year!

Hey Tomot,

I'm still listening.

We have been making incremental fixes now and then. I'll take this ping as a useful reminder to check the thread for things we still need to do...

thomthom

What would your preferred channel for API documentation issues be? This thread or the comment pages on the API pages?