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

DOC: Make UP006 easier to find #2469

Closed
wants to merge 1 commit into from
Closed

DOC: Make UP006 easier to find #2469

wants to merge 1 commit into from

Conversation

MartinThoma
Copy link

This change makes it easier to understand what UP006 is about. It also makes it easier to find the rule when you only know the effect, but not the PEP.

@not-my-profile
Copy link
Contributor

These Markdown tables in the README are autogenerated from our format strings in the Rust code and we don't want to change that format string to Use `dict` / `list` instead of `typing.Dict / typing.List` for type annotations since it would make the actual error messages less descriptive.

You are correct to note that the error format strings often aren't easy to understand. However we want to address this by introducing more thorough documentation #1467, rather than hardcoding specific values in our format strings.

@MartinThoma
Copy link
Author

Makes sense to me :-) I'm closing this as it's included in #1467. However, #1467 is pretty general. It would be nice to doc a single example rule well and then let the community help with following that example

@MartinThoma MartinThoma closed this Feb 2, 2023
@not-my-profile
Copy link
Contributor

Yes I agree :) However we firstly have to set up the documentation system ... we haven't done so yet since we're currently focusing on other issues but it's very much on our minds and the roadmap.

@charliermarsh
Copy link
Member

Want this to get much better!

@MartinThoma MartinThoma deleted the doc-up006 branch February 2, 2023 13:01
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.

3 participants