docs: Add instance argument to code samples in docstrings for component.py #7622
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
github-actions
bot
added
2.x
silvanocerza
added
the
ignore-for-release-notes
Pull Request Test Coverage Report for Build 8895200860Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issues
No issue opened
Proposed Changes:
The
instanceargument was missing from the sample code in the docstrings forcomponent.set_output_typesandcomponent.set_input_types. This caused me to write code that didn't work. I fixed my code, I would like to fix the docs.How did you test it?
I haven't yet.
Notes for the reviewer
I hope you have a nice day.
Checklist
[X] I have read the contributors guidelines and the code of conduct
[ ] I have updated the related issue with new insights and changes
[ ] I added unit tests and updated the docstrings
[X] I've used one of the conventional commit types for my PR title:
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.[ ] I documented my code
[ ] I ran pre-commit hooks and fixed any issue