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.

Sign up for GitHub

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

Jump to bottom

Generated docstring does not include :rtype when return type annotation is present #6470

Open
debonte opened this issue Sep 27, 2024 · 0 comments
Open

Generated docstring does not include :rtype when return type annotation is present #6470

debonte opened this issue Sep 27, 2024 · 0 comments
Assignees
@KacieKK
Labels
bug Something isn't working docstrings fixed in next version (main) A fix has been implemented and will appear in an upcoming version 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

:rtype is included because the return type (int) is specified.

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
@KacieKK KacieKK added the bug Something isn't working label Sep 28, 2024
@bschnurr bschnurr added the fixed in next version (main) A fix has been implemented and will appear in an upcoming version label Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KacieKK KacieKK

Labels
bug Something isn't working docstrings fixed in next version (main) A fix has been implemented and will appear in an upcoming version skip-reassign Optional label that tells the issue automation bot to not reassign the owner
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@bschnurr @debonte @KacieKK