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

[ENH] Consistent python formatting tool and configuration #1016

Closed
afender opened this issue Jul 22, 2020 · 7 comments
Closed

[ENH] Consistent python formatting tool and configuration #1016

afender opened this issue Jul 22, 2020 · 7 comments
Assignees
Labels
feature request New feature or request
Milestone

Comments

@afender
Copy link
Member

afender commented Jul 22, 2020

We should all use the same to avoid lengthy format changes between authors and facilitate reviews.

Initiated by #963 (comment)

@afender afender added the ? - Needs Triage Need team to review and classify label Jul 22, 2020
@afender afender added this to the 0.16 milestone Jul 22, 2020
@BradReesWork
Copy link
Member

@afender this sounds more like a documentation request rather than an feature.enhancement

@BradReesWork
Copy link
Member

We are going to follow the boy scout rule (https://www.matheus.ro/2017/12/11/clean-code-boy-scout-rule/) for updating variable names®

@BradReesWork BradReesWork added feature request New feature or request and removed ? - Needs Triage Need team to review and classify labels Aug 20, 2020
@afender
Copy link
Member Author

afender commented Sep 28, 2020

This is not really related to documentation or variable names.

This is more about the python formatting tool and configuration. In the past, we had PRs auto-editing hundreds of lines (like #963) because we don't have a common formating tool or configuration. So I think we should:

  • agree on one like Black that I think Chuck is using too
  • have all non-default settings (if any) published on the repo
  • run auto formating on all files

@kkraus14
Copy link
Contributor

cuDF uses a combination of Black, flake8, and isort for automatic formatting / linting of Python code. If possible I'd suggest following what cuDF has set up so we can maintain consistent for RAPIDS libraries. We have plans to centralize the configuration but haven't had the spare cycles to do so for now.

@BradReesWork BradReesWork modified the milestones: 0.16, 0.17 Sep 28, 2020
@BradReesWork BradReesWork modified the milestones: 0.17, 0.18 Nov 23, 2020
@rlratzel
Copy link
Contributor

Another checklist item for this issue should be:

@BradReesWork BradReesWork added the doc Documentation label Feb 1, 2021
@BradReesWork BradReesWork modified the milestones: 0.18, 0.19 Feb 1, 2021
@github-actions
Copy link

github-actions bot commented Mar 3, 2021

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@BradReesWork BradReesWork removed doc Documentation inactive-30d labels Mar 29, 2021
@afender
Copy link
Member Author

afender commented Mar 29, 2021

Closing after the last release discussion. The reformating problem has not shown up since then and everyone uses black or does the changes manually to comply with flake8.

@afender afender closed this as completed Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants