Emphasize that Pants doesn't dictate code layout #68
Conversation
This file contains 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
Emphasizes that Pants is compatible with a wide range of ways a codebase has been laid out by its own developers, rather than mandate that a codebase be forced to accommodate the tooling. * Breaks this message out into its own subsection * Leads with that message, rather than lead with example's choice * Eliminates the word "only", emphasizes the words "several" and "many"
Eric-Arellano
approved these changes
Mar 30, 2021
| This is only one possible way of laying out your project with Pants. See | ||
| [pantsbuild.org/docs/source-roots#examples](https://www.pantsbuild.org/docs/source-roots#examples) for some other | ||
| example layouts. | ||
| ## Codebase layout |
There was a problem hiding this comment.
Needs a new line between this and the next paragraph.
| [pantsbuild.org/docs/source-roots#examples](https://www.pantsbuild.org/docs/source-roots#examples) for some other | ||
| example layouts. | ||
| ## Codebase layout | ||
| _Pants does not expect you to reorganize your codebase._ This example repo demonstrates one of the many possible project codebase layouts that Pants works especially well with. See [pantsbuild.org/docs/source-roots#examples](https://www.pantsbuild.org/docs/source-roots#examples) for several other |
There was a problem hiding this comment.
Maybe "You should not need to reorganize your codebase to work with Pants"? The reality is that sometimes you do if you architected things poorly like tests not being hermetic, but generally you should not. We might want less strong of language, including not italicizing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Emphasizes that Pants is compatible with a wide range of ways a codebase has been laid out by its own developers, rather than mandate that a codebase be forced to accommodate the tooling.