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

ReadtheDocs: displayio.Display class documentation missing from 9.1.x versions #9690

Open
wminarik opened this issue Oct 6, 2024 · 2 comments

Comments

@wminarik
Copy link

wminarik commented Oct 6, 2024

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

@wminarik wminarik added the bug label Oct 6, 2024
@wminarik 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
@dhalbert
Copy link
Collaborator

dhalbert commented 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.

@wminarik
Copy link
Author

wminarik commented Oct 6, 2024

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:

display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst)
display = gc9a01.GC9A01(display_bus, width=240, height=240, rowstart=1, colstart=2,
                        backlight_pin=tft_bl, auto_refresh=False)

New syntax (I think):

display_bus = fourwire.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst)
display = gc9a01.GC9A01(display_bus, width=240, height=240, rowstart=1, colstart=2,
                        backlight_pin=tft_bl, auto_refresh=False)

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!

@dhalbert dhalbert added this to the 9.x.x milestone Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants