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

bug: Constructor parameters descriptions are not added to generated autodocs #899

Closed
edgarrmondragon opened this issue Aug 9, 2022 · 0 comments · Fixed by #900
Closed

bug: Constructor parameters descriptions are not added to generated autodocs #899

edgarrmondragon opened this issue Aug 9, 2022 · 0 comments · Fixed by #900
Assignees
@edgarrmondragon
Labels
Documentation Improvements or additions to documentation kind/Bug Something isn't working valuestream/SDK

Comments

@edgarrmondragon
Copy link
Collaborator

edgarrmondragon commented Aug 9, 2022 •
edited
Loading

Singer SDK Version

0.8.0

Python Version

NA

Bug scope

Other

Operating System

NA

Description

Constructor signatures are documented automatically with names and types, but parameter descriptions in our docstrings are not being added.

Code

No response
@edgarrmondragon edgarrmondragon added kind/Bug Something isn't working Documentation Improvements or additions to documentation valuestream/SDK labels Aug 9, 2022
@edgarrmondragon edgarrmondragon self-assigned this Aug 9, 2022
@edgarrmondragon edgarrmondragon linked a pull request Aug 9, 2022 that will close this issue
docs: Generate documentation for constructor parameters #900
Merged
@edgarrmondragon edgarrmondragon mentioned this issue Aug 9, 2022
Closed
@edgarrmondragon edgarrmondragon changed the title bug: Method parameters descriptions are not added to generated autodocs bug: Constructor parameters descriptions are not added to generated autodocs Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edgarrmondragon edgarrmondragon

Labels
Documentation Improvements or additions to documentation kind/Bug Something isn't working valuestream/SDK
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Generate documentation for constructor parameters meltano/sdk
1 participant
@edgarrmondragon