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

Positional vs keyward arg doc improvements #19

Closed
robhudson opened this issue Oct 26, 2013 · 1 comment
Closed

Positional vs keyward arg doc improvements #19

robhudson opened this issue Oct 26, 2013 · 1 comment

Comments

@robhudson
Copy link
Contributor

When working on projects that use the Python elasticsearch client I find myself jumping to the code to see which arguments are required (positional) and which are optional with reasonable default values.

I think it would benefit the docs to make this clearer.

@honzakral
Copy link
Contributor

The docs mention that you should always use keyword arguments - mostly for readibility, but also because of forwards compatibility - if an argument goes from required to optional or vice versa, relying on the order would cause errors.

If you know how to make this more prominent in the docs I'd be grateful.

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

No branches or pull requests

2 participants