Emphasize that Pants doesn't dictate code layout by cczona · Pull Request #68 · pantsbuild/example-python
Conversation
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"
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"
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Carina! Good idea.
| 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 |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
2 participants
