fields needs to be imported in examples#921
Merged
hynek merged 2 commits intopython-attrs:mainfrom Mar 14, 2022
chsachs:patch-1
Merged
fields needs to be imported in examples#921hynek merged 2 commits intopython-attrs:mainfrom chsachs:patch-1
hynek merged 2 commits intopython-attrs:mainfrom
chsachs:patch-1
Conversation
neither attrs as a whole nor field is imported from attrs. Therefore the example using field does not work if one goes through the examples step by step. either import fields from the beginning (as suggested) or in the example using fields.
Member
|
I would prefer if you imported field when it's used for the first time. Think it keeps the flow better. |
Member
I 100% agree in general, but I think it's fair enough to import the two most important functions at once. |
hynek
approved these changes
Mar 14, 2022
Member
|
Thanks! |
This file contains hidden or 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
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.
neither attrs as a whole nor field is imported from attrs. Therefore the example using field does not work if one goes through the examples step by step. either import fields from the beginning (as suggested) or in the example using fields.
Summary
Pull Request Check List
Our CI fails if coverage is not 100%.
.pyi).tests/typing_example.py.attr/__init__.pyi, they've also been re-imported inattrs/__init__.pyi.docs/api.rstby hand.@attr.s()have to be added by hand too.versionadded,versionchanged, ordeprecateddirectives.Find the appropriate next version in our
__init__.pyfile..rstfiles is written using semantic newlines.changelog.d.