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

RDS docs for 2.6.0 reflect features not in 2.6.0 release #1219

Open
jonathanq opened this Issue Jan 2, 2013 · 3 comments

Comments

Projects
None yet
3 participants
@jonathanq

jonathanq commented Jan 2, 2013

I was attempting to create an RDS instance using the docs at http://docs.pythonboto.org/en/latest/ref/rds.html. However boto 2.6.0 (release) is still using APIVersion 2011-04-01 so newer features like provisioned IOPS can't be used.

The docs state the APIVersion is 2012-09-17 and show using features like IOPS - but if you look at the 2.6.0 tagged release on github or a local install - it is still the 2011 API version.

>>> import boto
>>> from boto.rds import connect_to_region
>>> 
>>> boto.__version__
'2.6.0'
>>> 
>>> conn = connect_to_region(region_name='us-east-1', aws_access_key_id='<removed>', aws_secret_access_key = '<removed>')
>>> 
>>> conn.APIVersion
'2011-04-01'
>>> 

Obviously the PR (#1028) didn't make it into the 2.6.0 release. Any idea when we'll get a new release that inclues that PR?

I tried setting the APIVersion on the connection to '2012-09-17' - however I am still not able to create instances with provisioned iops as the code doesn't recognize the iops keyward arg.

@jamesls

This comment has been minimized.

Member

jamesls commented Jan 3, 2013

I believe more than a few people have ran into this issue. I think we can probably improve how we're setting the versions in the generated docs, but the link above is for the develop branch of boto, the docs for 2.6.0 (http://boto.readthedocs.org/en/2.6.0/ref/rds.html) show the correct API version.

Maybe we could proactively bump the __version__ in the develop branch after every release (though we'd have to know what the next release number is going to be), or always keep __version__ in the develop branch to 'develop' and just change it when it gets merged to master.

@garnaat Any thoughts?

@jonathanq

This comment has been minimized.

jonathanq commented Jan 3, 2013

James - I guess the confusion I had is that the wiki on github links to the /latest/ docs (which is 2.6.0-dev) - and just going to http://boto.readthedocs.org also sends you to the /latest/ docs. There is no link I could find to get to the 2.6.0 docs aside from changing the url. I'll do that to make sure i am looking at the right ones. Just think it may be confusing for some.

Even just updating the readme to point to the versioned docs /2.6.0/ instead of /latest/ would solve it I think.

@kopertop

This comment has been minimized.

Member

kopertop commented Jan 3, 2013

I agree, IMHO /latest/ should point to the latest release, and we should
make a /develop/ one for the latest development documentation.

On Thu, Jan 3, 2013 at 11:53 AM, Jonathan Quail notifications@github.comwrote:

James - I guess the confusion I had is that the wiki on github links to
the /latest/ docs (which is 2.6.0-dev) - and just going to
http://boto.readthedocs.org also sends you to the /latest/ docs. There is
no link I could find to get to the 2.6.0 docs aside from changing the url.
I'll do that to make sure i am looking at the right ones. Just think it may
be confusing for some.

Even just updating the readme to point to the versioned docs /2.6.0/
instead of /latest/ would solve it I think.


Reply to this email directly or view it on GitHubhttps://github.com//issues/1219#issuecomment-11851009.

Chris Moyer

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