Skip to content

Lint: one step forward through linting our code #10129

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

Merged
merged 13 commits into from
Mar 9, 2023
Merged

Lint: one step forward through linting our code #10129

merged 13 commits into from
Mar 9, 2023

Conversation

humitos
Copy link
Member

@humitos humitos commented Mar 8, 2023

I ran pre-commit through all the files to see what happened. This is the result after some manual tweaking. Each commit should contain more or less self-contained changes.


📚 Documentation previews 📚

@humitos
Copy link
Member Author

humitos commented Mar 8, 2023

The only one failing right now is prospector because we have a lot of docstring that are missing. Those would be probably good to solve as we go instead of in a one-time chunk of work --because that's never gonna happen 😄

@humitos humitos requested a review from benjaoming March 8, 2023 20:04
@humitos humitos marked this pull request as ready for review March 8, 2023 20:22
@humitos humitos requested review from a team as code owners March 8, 2023 20:22
@humitos humitos requested a review from agjohnson March 8, 2023 20:22
@humitos humitos removed request for a team and agjohnson March 8, 2023 20:23
@humitos humitos enabled auto-merge (squash) March 8, 2023 20:52
@humitos humitos disabled auto-merge March 8, 2023 20:52
Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

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

Great initiative to get this done.

This is the kind of PR that can't sit around for long.

I read from top to bottom and couldn't find anything beyond very very trivial.

If someone else can give it a look, they could maybe read from bottom to top so we have tired eyes at opposite ends :)

@@ -25,7 +23,7 @@ def render(self, data, accepted_media_type=None, renderer_context=None):
- sort_keys=True on json.dumps
- use str instead of six.text_types

https://github.com/encode/django-rest-framework/blob/master/rest_framework/renderers.py#L89
https://github.com/encode/django-rest-framework/blob/b7523f4/rest_framework/renderers.py#L84
Copy link
Contributor

Choose a reason for hiding this comment

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

🥇

@agjohnson
Copy link
Contributor

I only glanced at this, but I'm happy to see some incremental progress. I'm still a strong +1 on chipping away on linting/formatting until we have the entire repo automatically linted. Being able to rely on prettier/black for formatting in my editor is a big upgrade.

If someone else can give it a look, they could maybe read from bottom to top so we have tired eyes at opposite ends :)

This is an excellent strategy 👍

I feel like we've tried similar in other big refactor/linting PRs. Chunking up review makes it way less intimidating

@humitos humitos merged commit 87b9959 into main Mar 9, 2023
@humitos humitos deleted the humitos/linting branch March 9, 2023 08:44
humitos added a commit to readthedocs/common that referenced this pull request Mar 9, 2023
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