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.

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

Add an anti-pitch for typing #1477

Merged
merged 11 commits into from
Sep 26, 2023
Merged

Conversation

hauntsaninja
Copy link
Collaborator

No description provided.

@hauntsaninja
Copy link
Collaborator Author

@pfmoore Would the existence of this document help you? I've tried to represent things as fairly as possible, but I'm in quite deep and might be biased :-) Do you have any feedback?

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Member

@pfmoore pfmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this seems good, and sufficiently balanced.

It still puts the onus on the library author to justify their choice to not use typing (even if it’s just to the extent of linking to this) - that’s the social side of the problem, though, and documentation won’t fix that.

docs/source/typing_anti_pitch.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes a lot of sense. This feels a bit like the You Might Not Need Redux article by the original author of Redux. A few general notes:

  • Stylistic nit: I would lose the parentheses when discussing counterpoints. These are valid arguments and not just asides.
  • While it's okay for now, I think putting this document into an "FAQ" section would be a better fit than the "Guides" section.

docs/source/typing_anti_pitch.rst Show resolved Hide resolved
hauntsaninja and others added 7 commits September 25, 2023 19:47
Co-authored-by: Erik De Bonte <erikd@microsoft.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@hauntsaninja
Copy link
Collaborator Author

Thanks all! I think I got all the feedback; feel free to open a PR if there's something I missed :-)

@hauntsaninja hauntsaninja merged commit d8eeb1d into python:master Sep 26, 2023
2 checks passed
@hauntsaninja hauntsaninja deleted the anti-pitch branch September 26, 2023 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants