Deprecated link to usb.org in adafruit_hid documentation

adafruit / Adafruit_CircuitPython_HID

USB Human Interface Device drivers.

MIT License

373 stars 105 forks source link

Deprecated link to usb.org in adafruit_hid documentation #32

Closed jpecor closed 5 years ago

jpecor commented 5 years ago

There's a link to usb.org in the adafruit_hid.keycode.Keycode section of the documentation:

http://www.usb.org/developers/hidpage/Hut1_12v2.pdf#page=58

This link appears to be deprecated and leads to a Page Not Found error. I did some traversing around usb.org and found the _Hut112v2.pdf document here:

https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf

But I don't know for sure if that is the intended reference.

tannewt commented 5 years ago

@jpecor I imagine that is the correct document. Mind creating a PR to update it?

Will transfer this to the adafruit_hid repo now since that's where the PR will need to be.

jpecor commented 5 years ago

@tannewt - Yes, I'm happy to create a PR. Though, I don't know where to find the source for the readthedocs.io document.

dhalbert commented 5 years ago

The RTD doc is generated from inline documentation in the code. The obsolete link is here: https://github.com/adafruit/Adafruit_CircuitPython_HID/blob/master/adafruit_hid/keycode.py#L35. Thanks!

tannewt commented 5 years ago

Fixed by #33. Thanks @jpecor