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 documentation for AbstractWindow #718

Merged
merged 2 commits into from
Mar 15, 2021
Merged

Add documentation for AbstractWindow #718

merged 2 commits into from
Mar 15, 2021

Conversation

jwiggins
Copy link
Member

Closes #626

Copy link
Contributor

@aaronayres35 aaronayres35 left a comment

Choose a reason for hiding this comment

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

LGTM

Just one request:
could we change # to #: in the trait defs for the AbstractWindow class so they are also picked up by the api docs, not just the methods

docs/source/enable/abstract_window.rst Outdated Show resolved Hide resolved
@jwiggins
Copy link
Member Author

could we change # to #: in the trait defs for the AbstractWindow class so they are also picked up by the api docs

I actually prefer for them not to show up. Can you think of any traits that should be exposed to user code?

@aaronayres35
Copy link
Contributor

could we change # to #: in the trait defs for the AbstractWindow class so they are also picked up by the api docs

I actually prefer for them not to show up. Can you think of any traits that should be exposed to user code?

I guess that makes sense. It seems most (all?) the traits will be dealt with by enable inner machinery.

I think I am still a bit unclear on when we anticipate a user needing to mess with the AbstractWindow. Is the custom cursor scenario pretty much the only one that is common?
We are putting this in the user manual but I get the vibe that we don't really want users to touch or have to think about it

@jwiggins jwiggins merged commit 2160808 into master Mar 15, 2021
@jwiggins jwiggins deleted the docs/winders branch March 15, 2021 14:02
@jwiggins
Copy link
Member Author

Thanks for the feedback

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.

Enable: document window classes
2 participants