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

Generated docstring should have leading/trailing """ on their own lines #6471

Open
debonte opened this issue Sep 27, 2024 · 0 comments
Open
Assignees
Labels
docstrings skip-reassign Optional label that tells the issue automation bot to not reassign the owner

Comments

@debonte
Copy link
Contributor

debonte commented Sep 27, 2024

Environment data

  • Pylance version: 2024.9.102
  • OS and version: Windows 11
  • Python version: 3.9.12

Code Snippet

def foo(param1) -> int:
    """"""
    return 1

Repro Steps

  1. Trigger completion within """"""

Expected behavior

After generating the docstring, the leading and trailing """ are on their own lines. At least, in my experience, this is typical.

    """
    Docstring for foo
    
    :param param1: Description
    :type param1:  
    """

Actual behavior

    """Docstring for foo
    
    :param param1: Description
    :type param1:  """
@debonte debonte added docstrings skip-reassign Optional label that tells the issue automation bot to not reassign the owner labels Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstrings skip-reassign Optional label that tells the issue automation bot to not reassign the owner
Projects
None yet
Development

No branches or pull requests

2 participants