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

Configuration documentation error #2852

Closed
hjstein opened this issue May 6, 2021 · 5 comments
Closed

Configuration documentation error #2852

hjstein opened this issue May 6, 2021 · 5 comments
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation.

Comments

@hjstein
Copy link

hjstein commented May 6, 2021

Describe the bug

Page https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html?highlight=proxy gives the following code for calling Config from botocore.config:

import boto3
from botocore.config import Config
    
proxy_definitions = {
    'http': 'http://proxy.amazon.com:6502',
    'https': 'https://proxy.amazon.org:2010'
}
    
my_config = Config(
    'region_name': 'us-east-2',
    'signature_version': 'v4',
    'proxies': proxy_definitions
}

The code for the call to Config is not correct. It's not even syntactically correct python. It should be:

my_config = Config(
    region_name='us-east-2',
    signature_version='v4',
    proxies=proxy_definitions
)

Steps to reproduce
See above

Expected behavior
See above

Debug logs
Not relevant for documentation errors

@hjstein hjstein added the needs-triage This issue or PR still needs to be triaged. label May 6, 2021
@nateprewitt
Copy link
Contributor

nateprewitt commented May 6, 2021

Hey @hjstein,

Thanks for bringing this to out attention! This definitely looks like an issue. @shepazon would you mind taking a look at this?

@nateprewitt nateprewitt added bug This issue is a confirmed bug. documentation This is a problem with documentation. and removed needs-triage This issue or PR still needs to be triaged. labels May 6, 2021
@shepazon
Copy link
Contributor

shepazon commented May 6, 2021

Wow, how'd that get through like that? I even copied it from running code... sorry about that; will fix it imminently.

@nateprewitt
Copy link
Contributor

We were fortunate enough to have a contributor take care of it in #2853, so I think we're set. Thanks!

@nateprewitt
Copy link
Contributor

Resolved with #2853.

@github-actions
Copy link

github-actions bot commented May 7, 2021

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a confirmed bug. documentation This is a problem with documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants