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

Update docs to clarify proxy support #4101

Merged
merged 3 commits into from
Sep 27, 2019
Merged

Update docs to clarify proxy support #4101

merged 3 commits into from
Sep 27, 2019

Conversation

bbkane
Copy link
Contributor

@bbkane bbkane commented Sep 26, 2019

Clarify that, while aiohttp supports proxies that upgrade to HTTPS via CONNECT, it doesn't support proxies that must be connected to via https:// - #4100 .

I had trouble building the library (cchardet woudn't compile), so I was unable to preview the docs. Please review for RST syntax errors.

What do these changes do?

Update docs

Are there changes in behavior for the user?

None

Related issue number

Fixes #4100

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> for example (588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

Clarify that, while aiohttp supports proxies that upgrade to HTTPS via CONNECT, it doesn't support proxies that must be connected to via `https://` - #4100 .
Record change
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 26, 2019
@codecov-io
Copy link

codecov-io commented Sep 26, 2019

Codecov Report

Merging #4101 into master will decrease coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4101      +/-   ##
==========================================
- Coverage   97.86%   97.81%   -0.05%     
==========================================
  Files          43       43              
  Lines        8807     8807              
  Branches     1378     1378              
==========================================
- Hits         8619     8615       -4     
- Misses         75       78       +3     
- Partials      113      114       +1
Impacted Files Coverage Δ
aiohttp/web_fileresponse.py 96.59% <0%> (-1.14%) ⬇️
aiohttp/connector.py 96.93% <0%> (-0.33%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd9db9a...7ff2a6a. Read the comment docs.

docs/client_advanced.rst Outdated Show resolved Hide resolved
Differentiate types of HTTP proxies.

Co-Authored-By: Andrew Svetlov <[email protected]>
Copy link
Member

@asvetlov asvetlov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@asvetlov asvetlov merged commit be95c61 into aio-libs:master Sep 27, 2019
@asvetlov
Copy link
Member

thanks!

asvetlov pushed a commit that referenced this pull request Sep 27, 2019
* Update docs to clarify proxy support

Clarify that, while aiohttp supports proxies that upgrade to HTTPS via CONNECT, it doesn't support proxies that must be connected to via `https://` - #4100 .

* Create 1400.doc

Record change

* Update docs/client_advanced.rst

Differentiate types of HTTP proxies.

Co-Authored-By: Andrew Svetlov <[email protected]>
(cherry picked from commit be95c61)

Co-authored-by: Benjamin Kane <[email protected]>
@bbkane
Copy link
Contributor Author

bbkane commented Sep 27, 2019

Thank you!

asvetlov added a commit that referenced this pull request Sep 27, 2019
Clarify that, while aiohttp supports proxies that upgrade to HTTPS via CONNECT, it doesn't support proxies that must be connected to via `https://` - #4100 .

Co-Authored-By: Andrew Svetlov <[email protected]>
(cherry picked from commit be95c61)

Co-authored-by: Benjamin Kane <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs to say aiohttp doesn't support HTTPS proxies
3 participants