Doc Bug: Model.options code example

MaschMaker · March 11, 2019, 7:10pm

example code has a bug. This is the current example:

# Output all options available.
options_manager = Sketchup.active_model.options
options_manager.keys.each { |options_provider|
  puts options_provider.name
  options_provider.each { |key, value|
    puts "> #{key} - #{value}"
  }
}

The 2nd line of code should not include .keys and should just be:

options_manager.each { |options_provider|

Aerilius · March 12, 2019, 7:12am

Issues with the API docs can also be reported on Github: GitHub - SketchUp/ruby-api-stubs: Auto-generated stubs for the SketchUp Ruby API. Useful for IDE intellisense and auto-complete.

DanRathbun · March 12, 2019, 11:19pm

@Aerilius , Thomas has been moving all issue reports to the main official API issue tracker …

@MaschMaker, I’ve already offifcially reported this sample code error … see:

github.com/SketchUp/api-issue-tracker

Sketchup::Model # options() has broken code example

opened 06:50AM - 19 Feb 19 UTC

closed 04:49PM - 04 Jan 21 UTC

DanRathbun

Ruby API SketchUp documentation

### SketchUp Ruby API Issue ## [`Model # options()`][1] The code example d…oes not work because it is iterating an array of keyname strings. The **`String`** class does not have **`name()`** method, and the old Ruby 1.8 **`each()`** method has been removed. (The current example raises **`NoMethodError`** for both these.) **Here is a better working example:** ```ruby manager = Sketchup.active_model.options manager.keys.each {|provider| puts provider.to_s if manager[provider].size != 0 manager[provider].each {|key, value| puts "> #{key} - #{value}" } else puts "- (no options for this provider)" end puts } ``` If you wish not to use subscripting, then remove the chained call to **`.keys`**, viz: ```ruby manager = Sketchup.active_model.options manager.each {|provider| puts provider.name if provider.size != 0 provider.each {|key, value| puts "> #{key} - #{value}" } else puts "- (no options for this provider)" end puts } ``` ---------- And the "no options" clause is needed because there is actually one provider that has no options, and allows options to be added, (but SketchUp has a bug in handling them on the PC at least.) [1]: http://ruby.sketchup.com/Sketchup/Model.html#options-instance_method ---- _Originally [posted to the public forum](https://forums.sketchup.com/t/ruby-api-documentation-errors-suggestions/10958/16) in June of 2015 ..._

… as well as …

github.com/SketchUp/api-issue-tracker

Sketchup::OptionsProvider#each has broken code example

opened 12:51AM - 12 Mar 19 UTC

closed 04:49PM - 04 Jan 21 UTC

DanRathbun

Ruby API SketchUp documentation

### SketchUp Ruby API Issue - Documentation #### [`Sketchup::OptionsProvider#…each`](http://ruby.sketchup.com/Sketchup/OptionsProvider.html#each-instance_method) has broken code example. The example ... ```ruby model = Sketchup.active_model.options provider = model.options['UnitsOptions'] provider.each { |key, value| puts "#{key} = #{value}" } ``` ... results in the `NoMethodError` message ... ```Error: #<NoMethodError: undefined method `options' for #<Sketchup::OptionsManager:0x000279ae2fac90>>``` The easiest fix is to correct the first line to ... ```ruby model = Sketchup.active_model ``` ---- I believe that the intended example was meant to be ... ```ruby manager = Sketchup.active_model.options provider = manager['UnitsOptions'] provider.each { |key, value| puts "#{key} = #{value}" } ``` ... but someone didn't actually run the example. (tsk... tsk) ~

system · September 12, 2019, 7:19am

This topic was automatically closed 183 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
New to Learning Ruby for SketchUp Ruby API learning , newbie	8	3277	November 6, 2016
Ruby API Documentation - Errors & Suggestions Ruby API	44	9243	February 19, 2019
Ruby strange error Ruby API sketchup , ruby	14	1541	May 21, 2024
Free Examples of many SketchUp Ruby operations Ruby API	27	12786	April 30, 2015
Limiting decimals in ruby in SketchUp Ruby API decimals	1	897	February 11, 2017

Doc Bug: Model.options code example

Related topics