Skip to content

Documentation out of date #343

@Mambouna

Description

@Mambouna

The current documentation gives the keynames for keyboard capitalized here. When using these in PGZero projects however, warnings are emitted, that capitalized keynames are deprecated: DeprecationWarning: Uppercase keyboard attributes (eg. keyboard.M) are deprecated.

This could lead to confusion since the docs seem outdated.

If the idea was to align key names with pygame, where the alphabet is not capitalized (e.g. K_a, K_b, etc.), this still doesn't work as the warnings are also emitted for keys that are capitalized in pygame (e.g. K_SPACE is used in pygame, but keyboard.SPACE still gives the warning DeprecationWarning: Uppercase keyboard attributes (eg. keyboard.SPACE) are deprecated.).

It would also probably be good to align usage between keyboard and keys.

In summary, we need a consistent naming scheme to avoid confusion and update the docs when it is implemented. I see three broad possibilites: all capitalized, none capitalized, mixed capitalization following pygame.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions