Skip to content

add_text documentation for text wrapping is a little confusing #61

Closed
@dlizotte-uwo

Description

@dlizotte-uwo

Minor thing - documentation in add_text says:

        :param text_wrap: Whether or not to wrap text (for long text data chunks). Defaults to
                          ``False``, no wrapping.
        :param text_maxlen: The max length of the text for text wrapping. Defaults to 0.

But in the superclass version in PortalBase that's called, it says:

        :param text_wrap: When non-zero, the maximum number of characters on each line before text
                          is wrapped. (for long text data chunks). Defaults to 0, no wrapping.
        :param text_maxlen: The max length of the text. If non-zero, it will be truncated to this
                            length. Defaults to 0.

Suggest updating the MatrixPortal docs to match the PortalBase docs because I kept trying to use text_wrap = True and it was bad news. 😂

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions