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.

Sign up for GitHub

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

Jump to bottom

Auto Code Formatting #6

Closed
PJ-Finlay opened this issue Dec 21, 2020 · 4 comments
Closed

Auto Code Formatting #6

PJ-Finlay opened this issue Dec 21, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@PJ-Finlay
Copy link
Collaborator

Ideally there would be some sort of auto code formatting and linting. Related to this there is currently an issue with some of the documentation being formatted:
image

The goal is to comply with PEP 8 and PEP 257 to the extent possible.
@argosopentech argosopentech added help wanted Extra attention is needed good first issue Good for newcomers enhancement New feature or request documentation Improvements or additions to documentation labels Dec 21, 2020
@yogeshwaran01
Copy link
Contributor

@PJ-Finlay Try Black to format the python code

@PJ-Finlay
Copy link
Collaborator Author

@yogeshwaran01 Can you make a pull request?

@yogeshwaran01
Copy link
Contributor

yogeshwaran01 commented May 17, 2021 •
edited

@PJ-Finlay It is a CLI tool
First, install it

$ pip install black

and then run

$ black ~/path/to/file

After this, the code will be formatted properly according to PEP8

Formore about black check here

PJ-Finlay added a commit that referenced this issue May 17, 2021
@PJ-Finlay
Added code formatting with black
4d7841c 
- #6
@PJ-Finlay
Copy link
Collaborator Author

Thanks for the suggestion @yogeshwaran01, very easy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@PJ-Finlay @argosopentech @yogeshwaran01