Skip to content
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

Package breakes on multiline description of parameters #2

Open
churnikov opened this issue Sep 23, 2021 · 1 comment
Open

Package breakes on multiline description of parameters #2

churnikov opened this issue Sep 23, 2021 · 1 comment

Comments

@churnikov
Copy link

Hello!

Great package, but I have just encountered one problem:

If I write multiline description of parameter:

:param param: param
    param.

I get the following warning:

 WARNING: Unexpected indentation.

and result looks like this

image

@zwang123
Copy link
Owner

@churnikov Hello!

Thanks for your support and issue. I have to apologize for late response as my github account was lost and it was recovered recently.

Regarding your issue, I believe this is caused by the incorrect indentation. The package assumes indentation not to be decreased within the same block. You can see the difference between the two examples below.

def func_right(param=-1):
    """
    Example docstring.

    :param param: param
                  param.
    """
    ...

def func_wrong(param=-1):
    """
    Example docstring.

    :param param: param
        param.
    """
    ...

func_right will not complain this warning while func_wrong will, as is the result I obtained on my end.

Could you please modify your code and report the latest result?

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

No branches or pull requests

2 participants