Update the README. - #6
Merged
Merged
Conversation
This can serve as some very quick documentation for someone who just wants to play around without going through the full docsite. Also updates some config, notably removing pylint, since the repo doesn't conform to it.
Contributor
Author
|
See it rendered here: https://github.com/benjyw/example-python/blob/readme_updates/README.md |
Co-Authored-By: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
| # example-python | ||
| An example repo to demonstrate Python support in Pants v2. | ||
|
|
||
| See https://pants.readme.io/ for much more detailed documentation. |
Contributor
There was a problem hiding this comment.
You might want to mention the specific page in the docs for turning on V2 mode. This won't work properly if they use Pants without the correct config.
Contributor
Author
There was a problem hiding this comment.
This repo is already configured correctly. the README is intended to reflect examples in this repo, not general-purpose documentation, so I want to keep it succinct and not entangle any such issues. The documentation I linked to is our new v2-only documentation, so readers there should have all the info they need.
Co-Authored-By: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Eric-Arellano
approved these changes
Apr 14, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This can serve as some very quick documentation for
someone who just wants to play around without going
through the full docsite.
Also updates some config, notably removing pylint, since
the repo doesn't conform to it.