Skip to content

add_text documentation for text wrapping is a little confusing #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dlizotte-uwo opened this issue Feb 13, 2021 · 0 comments · Fixed by #62
Closed

add_text documentation for text wrapping is a little confusing #61

dlizotte-uwo opened this issue Feb 13, 2021 · 0 comments · Fixed by #62

Comments

@dlizotte-uwo
Copy link

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. 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant