Skip to content

[Doc]: Make rect argument consistent in the docstrings #22819

Closed
@greglucas

Description

@greglucas

Documentation Link

No response

Problem

The rect argument to functions is inconsistently documented in the codebase. We should consolidate the argument into a single choice.

The options I found searching for rect : are:

rect : tuple[float, float, float, float], optional
rect : sequence of float
rect : tuple (left, bottom, right, top), default: (0, 0, 1, 1)
rect : tuple of 4 floats, default: (0, 0, 1, 1)
rect : [left, bottom, width, height]
rect : (float, float, float, float)

Suggested improvement

Update all rect arguments to a single choice of one of the above for consistency.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationGood first issueOpen a pull request against these issues if there are no active ones!

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions