Skip to content

SketchUp 2027.0 - #91

Open
mirunaencuna wants to merge 3 commits into
mainfrom
staging
Open

mirunaencuna wants to merge 3 commits into
mainfrom
staging

Conversation

@mirunaencuna

Copy link
Copy Markdown

No description provided.

@@ -0,0 +1,15 @@
**SketchUp 2023 or later on Windows / SketchUp 2027 or later on macOS**

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this file for?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This formatting looks odd. Is this also in the API docs? How does it render when using YARD these stubs?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leading spaces will make line 71 render as code.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

# 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,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This starts with an incomplete sentence. Something is wrong here...?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

# For the last form that takes a Curve, the curve must be closed - like a
# circle.
#
# open operation if:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another odd section: "open operation if:"?

Indentation and formatting looks to be off as well?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

# @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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, do the section above belong to this @note?

Something broken in our API doc comment? Or in the stub generator?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This @note is working fine. So I'm not sure why the other notes appear broken...

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Following lines should not be indented.

def save_fill_pattern_to_file(file_name)
end

# the file is loaded; any others are ignored.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something is wrong here...

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

# layer.visible = false
#
# @note The behavior of +layer.visible = false+ differs from the UI when the layer is active.
#

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this @note render? The empty lines look odd.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

# @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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this section render in YARD?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It renders fine:
Screenshot 2026-10-12 at 13 43 11

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logged SKEXT-5556.

#
# @todo Add documentation.
#
# @version SketchUp 2025.0

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Space entities haven't been released yet. Is this on in release branch?

# @api InputBox
#
# @version SketchUp 2027.0
module UI::InputBox::ValueType

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was not release for 27.0. Is this on in release branch? or was the stubs generated from develop?

@DanRathbun DanRathbun Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My interest is peeked piqued.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I generated them from the release branch using bundle exec thor stubs:install, but now, after reviewing the Release Notes, I deleted them.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a released feature.

Comment thread pages/.DS_Store Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The constants are already listed in the YARD docs. Why assign them nil when they are Integer values?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the existing stubs in this repo and every constant is initialized as nil # Stub value, so I followed that pattern for consistency.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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'
#

@DanRathbun DanRathbun Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For an example of confusion, noise and exceptions occurring caused by double loading, see:

@thomthom thomthom left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mirunaencuna
mirunaencuna requested a review from thomthom October 30, 2026 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants