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

Aws::ElastiCache::Client#wait_until Documentation #860

Closed
reppard opened this issue Jul 2, 2015 · 2 comments
Closed

Aws::ElastiCache::Client#wait_until Documentation #860

reppard opened this issue Jul 2, 2015 · 2 comments
Labels
documentation This is a problem with documentation.

Comments

@reppard
Copy link

reppard commented Jul 2, 2015

http://docs.aws.amazon.com/sdkforruby/api/Aws/ElastiCache/Client.html#wait_until-instance_method

This could just be me but the documentation and more specifically the table at the bottom of the page led me to believe that in regard to these waiters, the maxium allowed delay is 15 and the maxium allowed attempts is 40. Turns out these are just the defaults. Any chance the docs can specify that these are default values and list any constants if any?

Thanks for the great work!

@awood45 awood45 added Version 2 documentation This is a problem with documentation. labels Jul 6, 2015
@awood45
Copy link
Member

awood45 commented Jul 6, 2015

I can see where there could be confusion here, will take a look at how we can word this.

awood45 added a commit that referenced this issue Jul 6, 2015
Waiter docs show the default delay and max attempts, but it is ambiguous
that these are default values. Change wording to make this explicit.

Resolves issue #860
awood45 added a commit that referenced this issue Jul 6, 2015
Less wordy, more directly shows where defaults are.

Resolves issue #860
@awood45
Copy link
Member

awood45 commented Jul 6, 2015

Thanks for bringing this to our attention. I've added the "Default" label to the table headers directly, and that will be reflected in the documentation after our next release.

@awood45 awood45 closed this as completed Jul 6, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants