You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
wminarik
changed the title
ReadtheDocs: displayio.Display class documentation mission from 9.1.x versions
ReadtheDocs: displayio.Display class documentation missing from 9.1.x versions
Oct 6, 2024
displayio.Display, .EPaperDisplay, .FourWire, and .I2CDisplay are deprecated in 9.x.x and will be removed in 10.0.0. That is why they were removed from the documentation. Perhaps displayio should contain cross-references to the new top-level modules: epaperdisplay, fourwire, i2cdisplaybus, and paralleldisplaybus, and busdisplay.
Thanks Dan -and on a weekend too...
I think cross-references are essential -there is a tremendous amount of documentation that references the depreciated way of doing things. Knowing now to look for the busdisplay docs helps to put the pieces together. Much of this complexity is hidden on boards with integral displays, but when adding displays to other boards, it's essential.
Old syntax:
but the only place where the options in the display constructor (width, height, auto_refresh, etc.) are documented currently is underbusdisplay -and no way to know to look there. These options are not mentioned or referenced on the fourwire page.
That is, the documentation needs to link the old way to the new way to avoid much confusion, at least for me!
CircuitPython version
documentation
Code/REPL
none
Behavior
The description of the displayio.Display class is missing from the 9.1.x branch ReadtheDocs pages, but is present in earlier versions: e.g. https://docs.circuitpython.org/en/8.2.x/shared-bindings/displayio/index.html
Perhaps it was lost during the reorganization of displayio for version 9.
Description
No response
Additional information
No response
The text was updated successfully, but these errors were encountered: