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

Documentation bug: evdev.EV_KEY #20

Closed
parke opened this issue Jan 3, 2014 · 3 comments
Closed

Documentation bug: evdev.EV_KEY #20

parke opened this issue Jan 3, 2014 · 3 comments

Comments

@parke
Copy link

parke commented Jan 3, 2014

On this page:
http://pythonhosted.org/evdev/apidoc.html#module-evdev.ecodes

evdev.ecodes.EV[evdev.EV_KEY]
'EV_KEY'

Should probably be:

evdev.ecodes.EV[evdev.ecodes.EV_KEY]
'EV_KEY'

(Hmm, I not sure how to escape the above triple greater-than characters.)

@gvalkov
Copy link
Owner

gvalkov commented Jan 3, 2014

It definitely shouldn't be that way. Thanks! Fixed in 701bb49 and already visible on http://python-evdev.readthedocs.org/en/latest/apidoc.html#module-evdev.ecodes

(You can use github flavored markdown to nicely format such blocks. E.g):

```python
evdev.ecodes.EV[evdev.ecodes.EV_KEY]
'EV_KEY'
```
evdev.ecodes.EV[evdev.ecodes.EV_KEY]
'EV_KEY'

@gvalkov gvalkov closed this as completed Jan 3, 2014
@parke
Copy link
Author

parke commented Jan 4, 2014

I think the following line needs to be fixed as well.

http://pythonhosted.org/evdev/apidoc.html#module-evdev.ecodes

evdev.ecodes.bytype[EV_REL][0]
'REL_X'

Should be: evdev.ecodes.bytype[evdev.ecodes.EV_REL][0]

What is the difference between the "normal" and .../latest/... versions of the documentation?

@gvalkov
Copy link
Owner

gvalkov commented Jan 4, 2014

Fixed.

The readthedocs.org documentation is automatically rebuilt on every commit, while the one on pythonhosted.org has to be built and uploaded manually (which is a hassle).

ismailof added a commit to ismailof/python-evdev that referenced this issue Feb 15, 2018
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