-
-
Notifications
You must be signed in to change notification settings - Fork 367
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.
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
docs: fix very minor typo #894
Conversation
Yeah, you're probably right. I'll change it to "very".
I personally use the explicit namespace in my own code, but that's partly also courtesy of "porting" using search-and-replace. One of the nice things of the new namespace is that it works both ways, the reason why it's using the imports is that i was being whiney when Tin suggested changing the docs to NG about the extra work when i introduce import attrs. I guess we could change the README back, but otherwise the fully qualified are a tad too long to use them everywhere I think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
@hynek One thought re the explicit namespace question might be to show/mention both ways once or twice in the docs just so people who like to copy paste exact examples at least see both ways and don't think it has to be all one way or the other or is considered "bad style." For example, between these two lines in "attrs by Example":
it could say something like this:
|
@hynek |
Summary
Very minor typo in docs (and a few other questions/points).
Thank you for the great release with 21.3.0... I have already updated a big project I'm working on to use it. :-)
I found this minor typo in the docs.
Also, a couple of other points questions if you don't mind -- I normally wouldn't bring these up in a PR, but since I'm not sure of another place to discuss this, I thought this was better than nothing:
1)
This is really minor, but the phrase "vastly popular" in
docs/names.rst
feels a bit awkward to me. I would expect to see "vastly more popular" if the intent is "people are abandoning the previous way in droves" or "very popular" if the intent is "people seem to really like the new way". I wasn't sure the intended meaning, so I didn't include this in the PR and just wanted to submit it for consideration.2)
This point is probably very controversial (and probably discussed somewhere else I'm not aware of), but I wanted to ask anyway. :-) Hopefully that's OK. :-) I was recently reviewing some code that used
@define
and it caused me to pause and think "what?!?" and then I remembered the "next gen" attrs stuff and it made sense. But to people not familiar with attrs and the modern API, it might leave them scratching their head for a bit. Yeah, I know at the top you would havefrom attrs import define
and that should clue them in. But wouldn't it be more explicit and clear to do this?I know people are free to do it either way and that changing the "recommended way" that's shown in the examples probably isn't something you guys want to change at this point, but I wanted to throw it out there since I think it would make it a bit more accessible for people new to attrs.
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.rst
by hand.@attr.s()
have to be added by hand too.versionadded
,versionchanged
, ordeprecated
directives.Find the appropriate next version in our
__init__.py
file..rst
files is written using semantic newlines.changelog.d
.