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

[PR #7995/43a5bc50 backport][3.10] Fix examples of fallback_charset_resolver function in client_advanced documentation #8045

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented Jan 21, 2024

This is a backport of PR #7995 as merged into master (43a5bc5).

What do these changes do?

This PR improves the client_advanced.rst documentation in the aiohttp project. It corrects the syntax in the fallback_charset_resolver function example. Specifically, it changes a miswritten 'lamba' to 'lambda' and adds .encode() to the tld parameter in the detect function call, ensuring proper byte format.

Are there changes in behavior for the user?

No changes in behavior for the end users are introduced. This PR solely improves the documentation for better clarity and correctness in the examples provided.

Related issue number

There's no specific related issue number for this PR. This is a direct improvement to the documentation based on observed inconsistencies.

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."

Copy link

codecov bot commented Jan 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4b91b53) 97.39% compared to head (60d518e) 97.39%.

Additional details and impacted files
@@           Coverage Diff           @@
##             3.10    #8045   +/-   ##
=======================================
  Coverage   97.39%   97.39%           
=======================================
  Files         108      108           
  Lines       32813    32813           
  Branches     3903     3903           
=======================================
  Hits        31958    31958           
  Misses        650      650           
  Partials      205      205           
Flag Coverage Δ
CI-GHA 97.30% <ø> (ø)
OS-Linux 96.99% <ø> (ø)
OS-Windows 94.52% <ø> (+<0.01%) ⬆️
OS-macOS 96.80% <ø> (ø)
Py-3.10.11 94.42% <ø> (ø)
Py-3.10.13 96.77% <ø> (-0.01%) ⬇️
Py-3.11.7 96.48% <ø> (ø)
Py-3.12.1 ?
Py-3.8.10 94.40% <ø> (+<0.01%) ⬆️
Py-3.8.18 96.71% <ø> (ø)
Py-3.9.13 94.41% <ø> (+<0.01%) ⬆️
Py-3.9.18 96.75% <ø> (-0.01%) ⬇️
Py-pypy7.3.15 96.30% <ø> (ø)
VM-macos 96.80% <ø> (ø)
VM-ubuntu 96.99% <ø> (ø)
VM-windows 94.52% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Dreamsorcerer Dreamsorcerer merged commit f47fa39 into 3.10 Jan 21, 2024
27 of 31 checks passed
@Dreamsorcerer Dreamsorcerer deleted the patchback/backports/3.10/43a5bc5097be31a25037fbfdbe39e86138a29cbd/pr-7995 branch January 21, 2024 01:36
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

Successfully merging this pull request may close these issues.

None yet

2 participants