Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add working example, clearer description, reorder arguments as in sig… #68

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Aerilius
Copy link
Contributor

The example of the method Sketchup::Entities#intersect_with was not helpful for understanding how this rather complex method works.

  • I added a working example
  • clearer description
  • reordered arguments to the same order as in the method signature
  • renamed arguments so that entities and corresponding transform have matching number. Previously one could think transform1 refers the transformation of entities1 although it refers to the receiver. One could also think transform2 refers to the list of entities entities2 although it refers to the target context for the intersection lines entities1.

…nature, rename arguments so that entities and corresponding transform have matching number
@DanRathbun
Copy link
Contributor

@Aerilius, This snippet suggestion would need to be opened as a documentation Issue in the API tracker.

(The stubs are generated from the C code comments and Thomas' script that used to accept PRs to change the core code has been broken for quite some time.)

@DanRathbun
Copy link
Contributor

Do we have a complimentary documentation issue open in the API tracker ?
(Does not look like it.) If this done, then this can be rejected and closed.

@DanRathbun
Copy link
Contributor

DanRathbun commented Aug 10, 2022

@thomthom This PR Issue can be rejected and closed as it way behind and you're no longer accepting PRs for the docs.
A complementary issue has been opened in the API tracker as: Issue 741 : Add better examples for entities.intersect_with

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.

2 participants