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

Docs fixups following #10534 #10568

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TimMenninger
Copy link
Contributor

What do these changes do?

Docs

Are there changes in behavior for the user?

No

Is it a substantial burden for the maintainers to support this?

No

Related issue number

N/A

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_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

    • if you don't have an issue number, change it to the pull request
      number after creating the PR

      • .bugfix: A bug fix for something the maintainers deemed an
        improper undesired behavior that got corrected to match
        pre-agreed expectations.
      • .feature: A new behavior, public APIs. That sort of stuff.
      • .deprecation: A declaration of future API removals and breaking
        changes in behavior.
      • .breaking: When something public is removed in a breaking way.
        Could be deprecated in an earlier release.
      • .doc: Notable updates to the documentation structure or build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and tooling. Changes in the test invocation considerations and
        runtime assumptions.
      • .contrib: Stuff that affects the contributor experience. e.g.
        Running tests, building the docs, setting up the development
        environment.
      • .misc: Changes that are hard to assign to any of the above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      Use the past tense or the present tense a non-imperative mood,
      referring to what's changed compared to the last released version
      of this project.

Sorry, something went wrong.

@TimMenninger TimMenninger mentioned this pull request Mar 16, 2025
5 tasks
Copy link

codspeed-hq bot commented Mar 16, 2025

CodSpeed Performance Report

Merging #10568 will not alter performance

Comparing TimMenninger:tcp-socket-factory-style-fixups (000d120) with master (1b96586)

Summary

✅ 47 untouched benchmarks

Copy link

codecov bot commented Mar 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (1b96586) to head (000d120).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #10568      +/-   ##
==========================================
- Coverage   98.71%   98.70%   -0.01%     
==========================================
  Files         125      125              
  Lines       37366    37366              
  Branches     2064     2064              
==========================================
- Hits        36884    36881       -3     
- Misses        335      338       +3     
  Partials      147      147              
Flag Coverage Δ
CI-GHA 98.58% <ø> (-0.01%) ⬇️
OS-Linux 98.24% <ø> (-0.01%) ⬇️
OS-Windows 96.19% <ø> (ø)
OS-macOS 97.36% <ø> (ø)
Py-3.10.11 97.27% <ø> (-0.01%) ⬇️
Py-3.10.16 97.81% <ø> (ø)
Py-3.11.11 97.89% <ø> (+0.04%) ⬆️
Py-3.11.9 97.36% <ø> (+<0.01%) ⬆️
Py-3.12.9 98.35% <ø> (ø)
Py-3.13.2 98.34% <ø> (-0.01%) ⬇️
Py-3.9.13 97.15% <ø> (ø)
Py-3.9.21 97.68% <ø> (+<0.01%) ⬆️
Py-pypy7.3.16 93.24% <ø> (+7.65%) ⬆️
VM-macos 97.36% <ø> (ø)
VM-ubuntu 98.24% <ø> (-0.01%) ⬇️
VM-windows 96.19% <ø> (ø)

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.

@TimMenninger TimMenninger force-pushed the tcp-socket-factory-style-fixups branch from c41d7a4 to b2cd192 Compare March 19, 2025 13:53
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Mar 19, 2025
@TimMenninger TimMenninger force-pushed the tcp-socket-factory-style-fixups branch from b2cd192 to 000d120 Compare March 19, 2025 14:05
@TimMenninger TimMenninger marked this pull request as ready for review March 19, 2025 15:32
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.

None yet

1 participant