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

Add tip for formatting files with yapf #2158

Closed
wants to merge 1 commit into from
Closed

Conversation

alok
Copy link
Contributor

@alok alok commented May 30, 2018

What do these changes do?

Tells devs how to use yapf easily.

Related issue number

#2149 Addresses @ericl request.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/5698/
Test FAILed.

Copy link
Contributor

@ericl ericl left a comment

Choose a reason for hiding this comment

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

Note that, it is good practice to not mix lint changes with logic changes. For example, here it took a while to locate the added text. Please keep this in mind in the future.

5. **Autoformatting code**. We use ``yapf``
https://github.com/google/yapf for linting, and the config file is
located at ``.style.yapf``. We recommend adding ``.travis/yapf.sh``
to git's ``pre-push`` hook, so that you never have to worry about
Copy link
Contributor

Choose a reason for hiding this comment

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

This is too slow to run on each push. How do you execute yapf against a subset of files, or only changed files?

@alok alok mentioned this pull request May 30, 2018
@alok alok closed this May 31, 2018
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