Skip to content

Conversation

@scoder
Copy link
Contributor

@scoder scoder commented May 11, 2023

@hauntsaninja hauntsaninja added the needs backport to 3.11 only security fixes label May 11, 2023
@rhettinger
Copy link
Contributor

It looks to me like all the information is already there. I don't really see a point in making the docs less readable by highlighting the least important information.

@scoder
Copy link
Contributor Author

scoder commented May 14, 2023

I don't really see a point in making the docs less readable by highlighting the least important information.

I agree that it's not relevant for many use cases, but it's a gotcha if it is. It definitely was a gotcha for me, Cython had this feature missing for quite a while, until someone noticed that it didn't work there (that was years ago). So – it's clearly not often needed, but that also means that it's very unlikely to be tested for and very likely to go unnoticed. And apparently, others have noticed the difference, too, and written up ticket capi-workgroup/problems#6.

OTOH, you could argue that the function name is such an obvious equivalent to set.__contains__ that people won't bother looking it up in the documentation at all, and, thus, won't notice the sentence either way, however visible it is in the docs…

@rhettinger
Copy link
Contributor

Thanks for the suggestion, but I'm going to decline. I don't buy that of the three sentences in the docs, that this one needs to be moved into a large box. It reads plainly enough and it covers a really minor, mostly unused feature.

@rhettinger rhettinger closed this May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants