New API doc - typos and questions

New API doc - typos and questions

Postby thomthom » Thu Feb 26, 2009 8:11 pm

I'm looking at the new API docs and I noted an inconsistency in the documentation. I thought we might collect them here as they're discovered and hopefully we'll see them addressed.

The example for Set.include? http://code.google.com/apis/sketchup/do ... ml#include? uses a different method name:
Code: Select all
status = set.contains? object
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby thomthom » Thu Feb 26, 2009 8:21 pm

Vector3d.linear_combination
http://code.google.com/apis/sketchup/do ... ombination

In addition to the 4-argument form detailed here, you may also call this method with 6 parameters in the form of:

Arguments:
weight1 - A weight or percentage.
vector1 - The first vector.
weight2 - A weight or percentage.
vector2 - The end point of the line.

What's the two extra arguments?
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Thu Feb 26, 2009 9:09 pm

Jim just pointed out this method and I noticed its missing:

Code: Select all
Face.get_glued_instances
0
Last edited by Chris Fullmer on Fri Feb 27, 2009 12:05 am, edited 1 time in total.
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby avariant » Thu Feb 26, 2009 11:22 pm

I'm pretty certain the material observer is completely wrong. The base class defines all but two methods incorrectly, and doesn't appear to use them all that correctly either.
0

avariant 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby ScottLininger » Thu Feb 26, 2009 11:31 pm

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

Your help in finding typos/missing details are very welcome! What isn't evident just from glancing at the site is that we have a new process internally for maintaining and updating the docs that will help us be more responsive to changes from here on out. (ThomThom, I've already pulled in your questions/corrections and will be pushing them out soon.)

By the way, HUGE thanks must be given to the people who worked on the wiki-enabled docs over the last couple of years. We integrated those community changes, and I'm currently doing a review to make sure that any changes from the last couple months are reflected in the new docs. Thank you! (The wiki docs are still up for now, and I will continue to monitor them for fixes.)

http://code.google.com/apis/sketchup/

Keep the corrections coming!
0
- Scott Lininger
SketchUp Software Engineer
Have you visited the Ruby API Docs?
User avatar
ScottLininger 
 

Re: New API doc - typos and questions

Postby ScottLininger » Fri Feb 27, 2009 12:31 am

Chris Fullmer wrote:Jim just pointed out this method and I noticed its missing:

Code: Select all
Face.get_glued_instances


Hey Chris (or Jim),

I don't think that's a standard method... (am I wrong?) I went to go add it to the docs, but I can't find it. Maybe it's part of some script out there?

Let me know, :)
0
- Scott Lininger
SketchUp Software Engineer
Have you visited the Ruby API Docs?
User avatar
ScottLininger 
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Fri Feb 27, 2009 12:37 am

Scott, I have question. This is coming from me, and I have little understanding of this documentation stuff. But is the SU Ruby code documented in a similar way to rDoc or something? Is it set up so that you guys can change the documentation, then run some rDoc like command on it and it automatically updates the website? Does that make sense?

Also, I like the tag that shows what version of SU each method is compatible with :)

Chris
0
Last edited by Chris Fullmer on Fri Feb 27, 2009 12:58 am, edited 1 time in total.
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby remus » Fri Feb 27, 2009 12:43 am

[ruby newb]i thought the face.get_glued_instances method was added with the latest M1 release?[/ruby newb]
0

remus 
 

Re: New API doc - typos and questions

Postby ScottLininger » Fri Feb 27, 2009 12:57 am

Chris Fullmer wrote:But is the SU Ruby code documented in a similar way to rDoc or something? Is it set up so that you guys can change the documentation, then run some rDoc like command on it and it automatically updates the website?


Yes.

We now generate the docs directly from source code comments, using something like rdoc. So we make a change to the source. It gets code reviewed and checked in. Then we push a button and it all goes onto the new site.

So... there are likely some "autogeneration" bugs that we will all discover over the coming weeks. Not to mention plain old human error. Which, by the way, is why the get_glued_instances method isn't up there. Remus is right, that was added with M1 and I am a bonehead. Fix coming! ;)

Thx,
0
- Scott Lininger
SketchUp Software Engineer
Have you visited the Ruby API Docs?
User avatar
ScottLininger 
 

Re: New API doc - typos and questions

Postby ScottLininger » Fri Feb 27, 2009 1:11 am

avariant wrote:I'm pretty certain the material observer is completely wrong. The base class defines all but two methods incorrectly, and doesn't appear to use them all that correctly either.


Attached script demonstrates using the MaterialsObserver as documented. The base class may not have all of the methods correctly implemented, but SketchUp will call them.

As the docs say, the onMaterialRemoveAll does not fire in a particularly useful way.

Let me know if you find anything else! Thanks!
0
- Scott Lininger
SketchUp Software Engineer
Have you visited the Ruby API Docs?
User avatar
ScottLininger 
 

Re: New API doc - typos and questions

Postby avariant » Fri Feb 27, 2009 2:03 am

I guess my blanket comments about the MaterialObserver were not entirely accurate ;) I was under the impression that unless some of the methods weren't explicitly implemented in the observer, SU would crash when it attempted to call the method since it's not implemented on the base. However, I seem to be wrong. :oops:
The documentation on onMaterialChange is a little inadequate. It says it is called whenever a material is altered, but it doesn't get called when you change size or color, just texture.
0

avariant 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Jim » Fri Feb 27, 2009 3:00 am

ScottLininger wrote:
Chris Fullmer wrote:Jim just pointed out this method and I noticed its missing:

Code: Select all
Face.get_glued_instances


Hey Chris (or Jim),

I don't think that's a standard method... (am I wrong?) I went to go add it to the docs, but I can't find it. Maybe it's part of some script out there?

Let me know, :)


Scott, I got the information from the Release Notes page.
0
Hi

Jim 
Global Moderator
 

Re: New API doc - typos and questions

Postby thomthom » Fri Feb 27, 2009 9:16 am

Noticed in another thread that there seem to be some deviation related to send_action. viewtopic.php?f=180&t=16751&start=15#p135201

"selectCameraOrbitTool:" doesnt work.
It's action name is simply OrbitTool.

Seems to be a couple more as well.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Todd Burch » Fri Feb 27, 2009 1:31 pm

ScottLininger wrote: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!
0

Todd Burch 
 

Re: New API doc - typos and questions

Postby thomthom » Fri Feb 27, 2009 2:39 pm

Under the UI Classes section:
Tool, Toolbar and Webdialog all links to the Array class: http://code.google.com/apis/sketchup/do ... array.html
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby ScottLininger » Sat Feb 28, 2009 7:17 am

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!
0
- Scott Lininger
SketchUp Software Engineer
Have you visited the Ruby API Docs?
User avatar
ScottLininger 
 

Re: New API doc - typos and questions

Postby thomthom » Sun Mar 01, 2009 10:39 am

Thanks Scott.

I'm still puzzled about the six arguments for Vector3d.linear_combination.
Code: Select all
vec = Geom::Vector3d.linear_combination(x, xaxis, y, yaxis, z, zaxis)

How does this really work?
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Sun Mar 01, 2009 5:45 pm

Not to mention that the example at the bottom of the method does not actually include the method of linear combination. It only shows:
Code: Select all
 vector1 = Geom::Vector3d.new 1,0,0
 vector2 = Geom::Vector3d.new 0,1,0
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Sun Mar 01, 2009 10:02 pm

PolygonMesh.add_polygon

The example shows how to use the add_point method.
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby thomthom » Sun Mar 01, 2009 10:09 pm

Wish we had red pens to scribble on the docs. :D
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Jim » Sun Mar 01, 2009 10:36 pm

thomthom wrote:Wish we had red pens to scribble on the docs. :D


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

Jim 
Global Moderator
 

Re: New API doc - typos and questions

Postby thomthom » Sun Mar 01, 2009 10:42 pm

Oh, yea... at least for Firefox. I mean to remember something like that.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby thomthom » Sun Mar 01, 2009 10:53 pm

Could this be something? https://addons.mozilla.org/en-US/firefox/addon/2792
Anyone tried it? Or got better solutions?
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Mon Mar 02, 2009 12:26 am

Point3d.project_to_plane:

http://code.google.com/apis/sketchup/do ... ct_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
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Mon Mar 02, 2009 2:35 am

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
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby thomthom » Tue Mar 03, 2009 4:40 pm

http://code.google.com/intl/nb/apis/ske ... l#inputbox

It doesn't mention how to allow drop-down options by using a third array with strings separating each option with a pipe | character.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Chris Fullmer » Tue Mar 03, 2009 5:13 pm

You can do a dropdown box?
0
Lately you've been tan, suspicious for the winter.
All my Plugins I've written
User avatar
Chris Fullmer 
SketchUp Team
SketchUp Team
 

Re: New API doc - typos and questions

Postby thomthom » Tue Mar 03, 2009 6:08 pm

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.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

Re: New API doc - typos and questions

Postby Jim » Tue Mar 03, 2009 10:12 pm

Chris Fullmer wrote:You can do a dropdown box?


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

Jim 
Global Moderator
 

Re: New API doc - typos and questions

Postby thomthom » Tue Mar 03, 2009 10:20 pm

Nice one Jim.
0
Thomas Thomassen — SketchUp Monkey & Coding addict
List of my plugins and link to the CookieWare fund
User avatar
thomthom 
PluginStore Author
PluginStore Author
 

SketchUcation One-Liner Adverts

by Ad Machine » 5 minutes ago



Ad Machine 
Robot
 

Next


 

Return to Developers' Forum

Who is online

Users browsing this forum: shechim and 4 guests

Visit our sponsors: