Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Document the client parameter for endpoint functions #561

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
Closed
johnthagen opened this issue Jan 3, 2022 · 0 comments
Closed

Document the client parameter for endpoint functions #561

johnthagen opened this issue Jan 3, 2022 · 0 comments
Labels
✨ enhancement New feature or improvement

Comments

@johnthagen
Copy link
Collaborator

johnthagen commented Jan 3, 2022 •
edited
Loading

Describe the bug

New docstring work in #551 added nicer docstrings, but fails to document the client parameter.

This leads PyCharm to put up Missing parameter in docstring warning for all of these parameters.

Screen Shot 2022-01-03 at 1 31 08 PM

To Reproduce

Open generated code in PyCharm 2021.3

Configure:

  • Settings | Search "Docstrings"

    • Tools | Python Integrated Tools | Docstrings | Docstring Format: Google

This would probably also flag on darglint, but I have not tested.

Expected behavior

If some args are documented, document all of them to avoid IDEs and linters from throwing warnings.

Desktop (please complete the following information):

  • OS: macOS 10.15.7
  • Python Version: 3.9.8
  • openapi-python-client version: 0.10.8
@johnthagen johnthagen added the 🐞bug Something isn't working label Jan 3, 2022
@dbanty dbanty added ✨ enhancement New feature or improvement and removed 🐞bug Something isn't working labels Jan 7, 2022
@dbanty dbanty changed the title New docstring format missing the client parameter Document the client parameter for endpoint functions Jan 7, 2022
@openapi-generators openapi-generators locked and limited conversation to collaborators Aug 13, 2023
@dbanty dbanty converted this issue into discussion #819 Aug 13, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Assignees
No one assigned
Labels
✨ enhancement New feature or improvement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@johnthagen @dbanty