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

docs: namespace.add_task(..., aliases=...) example does not work #396

Closed
jenisys opened this issue Oct 8, 2016 · 2 comments
Closed

docs: namespace.add_task(..., aliases=...) example does not work #396

jenisys opened this issue Oct 8, 2016 · 2 comments

Comments

@jenisys
Copy link

@jenisys jenisys commented Oct 8, 2016

VERSION: invoke-0.13.0 or newer (repo HEAD)
FILE: sites/doc/concepts/namespaces.rst

When you try the example that is described in the Aliases section:

ns.add_task(release, aliases=('deploy', 'pypi'))

it does not work because Collection.add_task() does not have an aliases parameter (or **kwargs argument). Note that the @task decorator still supports the aliases parameter.

SOLUTION (either / or):

  • Fix the documentation related to aliases
  • Provide the aliases parameter in the Collection.add_task() method again (?)
@bitprophet bitprophet added this to the 0.12.3 milestone Oct 10, 2016
@bitprophet
Copy link
Member

@bitprophet bitprophet commented Oct 10, 2016

Thanks for the catch!

@bitprophet
Copy link
Member

@bitprophet bitprophet commented Jul 14, 2017

Not sure if it was added in response to this ticket, but the docs have a 'FIXME' comment specifically about this.

Since I was in there anyway just now for other reasons, I fixed it. Hooray! The aliases kwarg is back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.