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 __doc__ to classes and methods #97

Open
sapoturge opened this issue Jun 28, 2019 · 1 comment
Open

Add __doc__ to classes and methods #97

sapoturge opened this issue Jun 28, 2019 · 1 comment

Comments

@sapoturge
Copy link

For people trying to use this library while learning how to do xcb programming, having no documentation anywhere makes doing simple things arbitrarily difficult. As an example, the ExposeEvent and ClientMessageEvent classes store the target window in event.window, but KeyPressEvent and MouseButtonEvent store the window in event.event. This information can be found online if you look hard enough, but it would be really nice if a docstring could be added to the classes explaining the attributes. The xml files do have documentation comments for some things, so those could be combined into Python docstrings when they exist.

@dperelman
Copy link
Contributor

As another user who is also just learning xcb, I agree better docs would be nice. I took a glance at the .xml files, and it looks like a lot of it is undocumented there and there doesn't appear to be structured documentation. For example, this appears to be the source-of-truth on documentation of the X11 protocol and its documentation of XInput is just a text file that doesn't appear to have any structured reference to the source. Of course, maybe that means xcb-proto should be fixed to have better docs...

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