Skip to content

Documentation rendering improperly for keys function. #40

Closed
@kattni

Description

@kattni

The list of properties in the keys documentation renders with the final member of the list as bold: https://docs.circuitpython.org/projects/macropad/en/latest/api.html#adafruit_macropad.MacroPad.keys

The solution that worked elsewhere for me was to indent the wrapped text below the initial line with two spaces only, e.g. update it to match what is shown here:

        * ``released``: ``True`` if the event is a transition from pressed to released.
          ``released`` is always the opposite of ``pressed``; it's provided for convenience
          and clarity, in case you want to test for key-release events explicitly.

If what is shown above is not clear, remove the indentation on the wrapped text back to equal with the *, and then indent the wrapped text by only two spaces.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions