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 hello world plugin to documentation #6587

Merged
merged 4 commits into from Oct 4, 2018

Conversation

Projects
None yet
4 participants
@jakubbujny
Copy link
Contributor

jakubbujny commented Oct 3, 2018

Documentation improvement showing simple hello world plugin which define hello-world goal with 2 tasks: hello and world. That should be useful for new people in Pants (I've also been there).

I tested that locally and looks ok.

Jakub Bujny added some commits Oct 3, 2018

Jakub Bujny
from hello.tasks.your_tasks import HelloTask, WorldTask

def register_goals():
Goal.register(name="hello-world", description="Say hello to our world")

This comment has been minimized.

@amilnarski

amilnarski Oct 4, 2018

For consistency with the goals output below shouldn't the description be "Say hello to your world"?

@jakubbujny

This comment has been minimized.

Copy link
Contributor

jakubbujny commented Oct 4, 2018

@amilnarski I made a fix according to your suggestion

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Oct 4, 2018

This is great content, thanks!

There are maybe some English language changes I would suggest, but I don't want to bog you down with those, so I'm fine committing this and then I can follow up with a commit that just tweaks the grammar etc.

@stuhood

stuhood approved these changes Oct 4, 2018

Copy link
Member

stuhood left a comment

Thanks for this!

I've made a few edits... will land on green.

@benjyw

benjyw approved these changes Oct 4, 2018

Copy link
Contributor

benjyw left a comment

Thanks for getting in the language fixes before I had a chance to, @stuhood . :)

@jakubbujny

This comment has been minimized.

Copy link
Contributor

jakubbujny commented Oct 4, 2018

Thank you so much for language fixes!

@stuhood stuhood merged commit 2cb66ac into pantsbuild:master Oct 4, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@jakubbujny

This comment has been minimized.

Copy link
Contributor

jakubbujny commented Oct 5, 2018

Guys I see that code blocks are not formatted on docs site https://www.pantsbuild.org/howto_plugin.html - how to fix that?

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Oct 5, 2018

I'll fix it up (and will do some language edits while I'm in there, if you're OK with that).

@jakubbujny

This comment has been minimized.

Copy link
Contributor

jakubbujny commented Oct 5, 2018

Sure, that's more than welcome :)

@benjyw

This comment has been minimized.

Copy link
Contributor

benjyw commented Oct 5, 2018

See #6601

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment