Repository navigation
SketchUp 2027.0 - #91
mirunaencuna wants to merge 3 commits into
Conversation
| @@ -0,0 +1,15 @@ | |||
| **SketchUp 2023 or later on Windows / SketchUp 2027 or later on macOS** | |||
There was a problem hiding this comment.
I would think it is a markdown table to insert into constructor docstring for the UI::HtmlDialog class. It would likely replace the existing table with the dialog style constants.
| # line in world coordinates. | ||
| # | ||
| # objects. Point 0: leader break point, where the text extension attaches. Point 1: attach point, | ||
| # where leader touches the arc/circle. Point 2: opposite |
There was a problem hiding this comment.
This formatting looks odd. Is this also in the API docs? How does it render when using YARD these stubs?
There was a problem hiding this comment.
Leading spaces will make line 71 render as code.
| # The leader_points method returns the 3 significant points along the dimension | ||
| # line in world coordinates. | ||
| # | ||
| # objects. Point 0: leader break point, where the text extension attaches. Point 1: attach point, |
There was a problem hiding this comment.
This starts with an incomplete sentence. Something is wrong here...?
| # For the last form that takes a Curve, the curve must be closed - like a | ||
| # circle. | ||
| # | ||
| # open operation if: |
There was a problem hiding this comment.
Another odd section: "open operation if:"?
Indentation and formatting looks to be off as well?
| # @note A special case exists for any face created on the ground plane, in | ||
| # which case the vertex order is ignored and the face is always facing down. | ||
| # | ||
| # @note When using the edge array or curve overload this method will return +nil+ and abort any |
There was a problem hiding this comment.
Oh, do the section above belong to this @note?
Something broken in our API doc comment? Or in the stub generator?
There was a problem hiding this comment.
Likely YARD output is out of order due to indentation. Any line with 2 leading spaces will be rendered as code. I think @note blocks are always rendered last. So if note lines are indented, they end up rendering as code blocks in front of the note.
| # status = entity1.set_attribute "testdictionary", "test", 115 | ||
| # | ||
| # @note {Geom::Point3d} or {Geom::Vector3d} array values stored as vertex | ||
| # attributes are automatically transformed when the vertex is moved. |
There was a problem hiding this comment.
This @note is working fine. So I'm not sure why the other notes appear broken...
There was a problem hiding this comment.
Following lines should not be indented.
| def save_fill_pattern_to_file(file_name) | ||
| end | ||
|
|
||
| # the file is loaded; any others are ignored. |
| # layer.visible = false | ||
| # | ||
| # @note The behavior of +layer.visible = false+ differs from the UI when the layer is active. | ||
| # |
There was a problem hiding this comment.
How does this @note render? The empty lines look odd.
| # @return [Array<Sketchup::Drawingelement>] an array of drawing elements that are | ||
| # *hidden* on the page. | ||
| # @note Behavior depends on which hidden-visibility flags are used: | ||
| # - SketchUp 2020.1 and later: |
There was a problem hiding this comment.
How does this section render in YARD?
There was a problem hiding this comment.
I think this needs improvements. But that should be done at the source. Can you log a ticket for followup to clean up here? We should mark inline code with inline code syntax.
| # | ||
| # @todo Add documentation. | ||
| # | ||
| # @version SketchUp 2025.0 |
There was a problem hiding this comment.
Space entities haven't been released yet. Is this on in release branch?
| # @api InputBox | ||
| # | ||
| # @version SketchUp 2027.0 | ||
| module UI::InputBox::ValueType |
There was a problem hiding this comment.
This was not release for 27.0. Is this on in release branch? or was the stubs generated from develop?
There was a problem hiding this comment.
My interest is peeked piqued.
There was a problem hiding this comment.
I generated them from the release branch using bundle exec thor stubs:install, but now, after reviewing the Release Notes, I deleted them.
There was a problem hiding this comment.
Something is wrong with the stub generator script if this was generated from release branch. We should find root cause. There should not be any manual cleanup needed on the generated output.
| # @todo Complete documentation. | ||
| # | ||
| # @version SketchUp 2027.0 | ||
| class UI::InputBox |
There was a problem hiding this comment.
This is not a released feature.
There was a problem hiding this comment.
This file should not be checked in. gitignore it.
| CORNER_RIGHT_BACK_TOP = nil # Stub value. | ||
| CORNER_RIGHT_FRONT_BOTTOM = nil # Stub value. | ||
| CORNER_RIGHT_FRONT_TOP = nil # Stub value. | ||
|
|
There was a problem hiding this comment.
The constants are already listed in the YARD docs. Why assign them nil when they are Integer values?
There was a problem hiding this comment.
I checked the existing stubs in this repo and every constant is initialized as nil # Stub value, so I followed that pattern for consistency.
There was a problem hiding this comment.
Docs doesn't display constant values, the actual value is implementation detail that might be subject to change.
| # # core.rb. | ||
| # require 'sketchup.rb' | ||
| # require 'extensions.rb' | ||
| # |
There was a problem hiding this comment.
The file extension should not be specified. Doing so causes a reload by the require method when other file have already loaded it with just require 'sketchup', etc. The reloads cause excessive noise in the Ruby Console with messages about constants already defined.
This also applies to loading Ruby standard library files, such as: require 'json', require 'fiddle', and so forth.
There was a problem hiding this comment.
For an example of confusion, noise and exceptions occurring caused by double loading, see:
thomthom
left a comment
There was a problem hiding this comment.
I'm making this as Requested changes while we wait for the doc and stub generatpr fixes up stream. Makes the Review Inbox easier to read.

No description provided.