nngogol / PySimpleGUIDocGen

Software for making documentation for PySimpleGUI
9 stars 2 forks source link

Newlines inside of parameter descriptions legal? #43

Closed MikeTheWatchGuy closed 5 years ago

MikeTheWatchGuy commented 5 years ago

Sometimes I add a newline to break up long lines. Is this a legal thing to do with your software?

Here's my docstring with the "offensive newline"

class Column(Element):
    """
    A container element that is used to create a layout within your window's layout
    """

    def __init__(self, layout, background_color=None, size=(None, None), pad=None, scrollable=False,
                 vertical_scroll_only=False, right_click_menu=None, key=None, visible=True):
        """
        :param layout: List[List[Element]] Layout that will be shown in the Column container
        :param background_color: (str) color of background of entire Column
        :param size: Tuple[int, int] (width, height) size in pixels (doesn't work quite right, sometimes
                      only 1 dimension is set by tkinter
        :param pad: (int, int) or ((int, int),(int,int)) Amount of padding to put around element (left/right, top/bottom) or ((left, right), (top, bottom))
        :param scrollable: (bool) if True then scrollbars will be added to the column
        :param vertical_scroll_only: (bool) if Truen then no horizontal scrollbar will be shown
        :param right_click_menu: List[List[str]] see "Right Click Menus" for format
        :param key:  (any)  Value that uniquely identifies this element from all other elements. Used when Finding an element or in return values. Must be unique to the window
        :param visible: (bool) set visibility state of the element
        """

It's the size parameter that I have a newline in there. It comes out looking like this: image

The text following the newline was put into the first column. I would think if supported it would be in the second column.

MikeTheWatchGuy commented 5 years ago

If it's not supported, I'll simply change the code to remove the newlines.

nngogol commented 5 years ago

fixed in last version