New API doc - typos and questions

todd burch

Hello everyone,

Yes, we just launched some new docs for the Ruby API on the code site. These are the most accurate and up to date documentation we have ever had, and we hope that they are useful. (That being said, there is obviously still room for improvement.)

Thanks Scott!

thomthom

Under the UI Classes section:
Tool, Toolbar and Webdialog all links to the Array class: http://code.google.com/apis/sketchup/docs/ourdoc/array.html

scottlininger

A bunch of fixes got pushed on Friday. Thanks again to folks who found typos, both from this thread and from the wiki documentation. Keep 'em coming!

I'm on vacation for the next week, so don't think I'm ignoring anyone if I don't reply for a few days. Thanks, guys!

thomthom

Thanks Scott.

I'm still puzzled about the six arguments for Vector3d.linear_combination.

vec = Geom;;Vector3d.linear_combination(x, xaxis, y, yaxis, z, zaxis)

How does this really work?

Chris Fullmer

Not to mention that the example at the bottom of the method does not actually include the method of linear combination. It only shows:

 vector1 = Geom;;Vector3d.new 1,0,0
 vector2 = Geom;;Vector3d.new 0,1,0

Chris Fullmer

PolygonMesh.add_polygon

The example shows how to use the add_point method.

thomthom

Wish we had red pens to scribble on the docs.

Jim

@thomthom said:

Wish we had red pens to scribble on the docs.

Great idea, really. I'm sure there are browser plugins that allow social sharing of sticky notes, or comments on web pages.

thomthom

Oh, yea... at least for Firefox. I mean to remember something like that.

thomthom

Could this be something? https://addons.mozilla.org/en-US/firefox/addon/2792
Anyone tried it? Or got better solutions?

Chris Fullmer

Point3d.project_to_plane:

http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#project_to_line

Shows the wrong example code (uses from project to line). and I know I gave the link for project_to_line. Its so you can see both methods simultaneously and see the error better. Thanks!

Chris

Chris Fullmer

So far I am really truly enjoying the new docs. They feel much better, thanks for the efforts to get them to where they are. I'm also excited that changes might be able to happen faster now too, that is great.

I'm noticing that sometimes in the methods list, when I click on a method, it takes me to the class index for that method. Other times it willtake me directly to the entry for that method within the class. I prefer the latter. But I don't know why sometimes it does one thing and sometimes it does another,

Chris

thomthom

Error 404 (Not Found)!!1

(code.google.com)

It doesn't mention how to allow drop-down options by using a third array with strings separating each option with a pipe | character.

Chris Fullmer

You can do a dropdown box?

thomthom

UI.inputbox ['Hello'], ['World'], ['Mars|Pluto|World|Monkeys'], 'Title'

"Global Material Changer" and "Component Spray" uses it. That's the only way I knew it was possible.

Jim

@chris fullmer said:

You can do a dropdown box?

Sure, and I made this to ease the pain a little: http://sketchuptips.blogspot.com/2008/03/inputbox-class.html

thomthom

Nice one Jim.

Chris Fullmer

http://code.google.com/apis/sketchup/docs/ourdoc/point3d.html#z=

It says:

Point3d.z=

    The y= method is used to set the z value of a 3D point.

That second line should say "The z= method..."

thomthom

Error 404 (Not Found)!!1

(code.google.com)

Face.area actually takes an optional argument. I'm not sure what the argument is. It accepts pure numbers which then seems to be a scale factor. But it also accepts Transformation objects.

thomthom

Same applies to Edge.length