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

_top_level.rb - align with comments in Tools/sketchup.rb #83

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MSP-Greg
Copy link

Used a very recent version of Tools/sketchup.rb

I noticed that add_separator_to_menu was deprecated...

@DanRathbun
Copy link
Contributor

DanRathbun commented Aug 14, 2023

FYI: The stubs are generated from the C code comments using Thomas' custom YARD template (see it's repository.)

The reverse changes from Git PRs has been broken for years and does not seem to have any priority.

@MSP-Greg
Copy link
Author

@DanRathbun

FYI: The stubs are generated from the C code comments

The top-level methods I'm referring to are in a Ruby file, Tools/sketchup.rb

@DanRathbun
Copy link
Contributor

Used a very recent version of Tools/sketchup.rb

Ah ... .okay. But very recent changes likely have not yet been pushed to the public stubs repositories.
This usually will be done as part of a release cycle in which there are known API changes.

What I'm getting at is that it makes no sense to do PRs on this repository as it will all get overwritten anyway.

Also, I can see that the public API YARD docs have this method set to deprecated already.
So there may be a mismatch between what is generated for the docs and what is generated for the stubs.
We might consider this a bug in the stubs generation. Thomas would know best which.
(Ie, if it is a bug, it may be an issue for the template repository.)

However, coders who generate their own docs, might need to make this change to their own repository.


I also do not see the point in moving the deprecated YARD tags to the top of each method comment block.

Is this done for example for ComponentDefinition#insertion_point in "ComponentDefinition.rb" ? NO
The method docstring always appears to begin the YARD comment block for SketchUp documentation.
The listing order of the @deprecated YARD tag can otherwise vary.

@thomthom
Copy link
Member

Hm... it could be that there's a bug in the stub-generation. I'd have to investigate.

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