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

Fix examples of fallback_charset_resolver function in client_advanced documentation #7995

Merged
merged 3 commits into from Jan 21, 2024

Conversation

henry0312
Copy link
Contributor

@henry0312 henry0312 commented Dec 26, 2023

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

@henry0312 henry0312 changed the title Fix fallback_charset_resolver function in client_advanced documentation Fixed examples of fallback_charset_resolver function in client_advanced documentation Dec 26, 2023
@henry0312 henry0312 changed the title Fixed examples of fallback_charset_resolver function in client_advanced documentation Fix examples of fallback_charset_resolver function in client_advanced documentation Dec 26, 2023
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Dec 26, 2023
@henry0312 henry0312 marked this pull request as ready for review December 26, 2023 07:10
@Dreamsorcerer Dreamsorcerer added backport-3.9 Trigger automatic backporting to the 3.9 release branch by Patchback robot backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot labels Dec 26, 2023
Copy link

codecov bot commented Dec 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (43f3e23) 97.46% compared to head (0e64944) 97.46%.
Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #7995   +/-   ##
=======================================
  Coverage   97.46%   97.46%           
=======================================
  Files         107      107           
  Lines       32551    32551           
  Branches     3793     3793           
=======================================
  Hits        31725    31725           
  Misses        624      624           
  Partials      202      202           
Flag Coverage Δ
CI-GHA 97.37% <ø> (ø)
OS-Linux 97.05% <ø> (ø)
OS-Windows 95.55% <ø> (ø)
OS-macOS 96.86% <ø> (-0.01%) ⬇️
Py-3.10.11 95.47% <ø> (ø)
Py-3.10.13 96.86% <ø> (ø)
Py-3.11.7 96.60% <ø> (ø)
Py-3.12.1 96.64% <ø> (-0.03%) ⬇️
Py-3.8.10 95.44% <ø> (ø)
Py-3.8.18 96.79% <ø> (ø)
Py-3.9.13 95.44% <ø> (ø)
Py-3.9.18 96.83% <ø> (ø)
Py-pypy7.3.14 ?
Py-pypy7.3.15 96.38% <ø> (?)
VM-macos 96.86% <ø> (-0.01%) ⬇️
VM-ubuntu 97.05% <ø> (ø)
VM-windows 95.55% <ø> (ø)

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 43a5bc5 into aio-libs:master Jan 21, 2024
31 of 34 checks passed
Copy link
Contributor

patchback bot commented Jan 21, 2024

Backport to 3.9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.9/43a5bc5097be31a25037fbfdbe39e86138a29cbd/pr-7995

Backported as #8044

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Copy link
Contributor

patchback bot commented Jan 21, 2024

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/43a5bc5097be31a25037fbfdbe39e86138a29cbd/pr-7995

Backported as #8045

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Jan 21, 2024
Dreamsorcerer pushed a commit that referenced this pull request Jan 21, 2024
…resolver` function in client_advanced documentation (#8045)

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

Co-authored-by: OMOTO Tsukasa <tsukasa@oomo.to>
Dreamsorcerer pushed a commit that referenced this pull request Jan 21, 2024
…esolver` function in client_advanced documentation (#8044)

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

Co-authored-by: OMOTO Tsukasa <tsukasa@oomo.to>
@henry0312 henry0312 deleted the fix_docs branch January 21, 2024 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.9 Trigger automatic backporting to the 3.9 release branch by Patchback robot backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot 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.

None yet

2 participants