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

[docs] API documentation errors #3466

Closed
eerohele opened this issue Jul 12, 2020 · 2 comments
Closed

[docs] API documentation errors #3466

eerohele opened this issue Jul 12, 2020 · 2 comments

Comments

@eerohele
Copy link

Description

Two errors in the API docs:

  1. According to the API docs, view.find_by_class() returns a Region. It actually returns a point (int).
  2. According to the same API doc page, window.show_quick_panel() takes a keyword argument called on_highlighted. Actually, the name of the keyword argument is on_highlight.

Environment

  • Build: 4074
@UltraInstinct05
Copy link
Contributor

I believe these and a lot of other inconsistencies are listed in #2290

@eerohele
Copy link
Author

Ah, you're right. Apologies for the duplicate. I'll close this one.

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

No branches or pull requests

2 participants