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

📝 Update documentation to refer to list instead of List #1147

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

bubbletroubles
Copy link

All of the examples use lowercase list, but this text referrers to List (which is imported from Typing).

I suspect it's supposed to be lowercase.

@github-actions github-actions bot added the docs Improvements or additions to documentation label Oct 26, 2024
@bubbletroubles bubbletroubles changed the title Possible typo - List instead of list Docs - Possible typo - List instead of list Oct 26, 2024
Copy link

@svlandeg svlandeg changed the title Docs - Possible typo - List instead of list 📝 Update documentation to refer to list instead of List Feb 24, 2025
Copy link
Member

@svlandeg svlandeg left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution!

Yes - this is a good catch. The older Python 3.7 examples do use List, but it makes sense to update the surrounding text to reflect the newest examples. In fact, I searched through the documentation and there's more cases like this, still referring to List. I'll take this opportunity to update all of them.

@svlandeg svlandeg marked this pull request as draft February 24, 2025 09:54
@svlandeg svlandeg self-assigned this Feb 24, 2025
Copy link

@svlandeg svlandeg marked this pull request as ready for review February 24, 2025 10:05
Copy link
Member

@svlandeg svlandeg 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 should be ready to merge! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants