Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Documentation of AnchoredText's prop keyword argument is misleading #12467

Closed
@galenlynch

Description

@galenlynch

This bug is nearly identical to #12121, but affects AnchoredText instead of TextArea.

The documentation for AnchoredText strongly suggests that the keyword argument prop should be a FontProperties object. However, inspecting the source code suggests that prop should instead be a dictionary of keyword arguments that will be passed to the TextArea object inside of AnchoredText.

I propose rewording the documentation to make it clear that prop should be a dictionary of keyword arguments to construct the TextArea instance.

Perhaps it would be worthwhile to look over the documentation of other classes in offsetbox for similar issues, since this is the second time I've come across the same issue.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions