Skip to content

gh-107028: tiny textual changes in logging docs and docstrings #107029

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

Merged
merged 8 commits into from
Jul 22, 2023

Conversation

JochemBoersma
Copy link
Contributor

@JochemBoersma JochemBoersma commented Jul 22, 2023

I've done a tiny change in docstrings, to make documentation in line with the actual behavior of the function.


📚 Documentation preview 📚: https://cpython-previews--107029.org.readthedocs.build/

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

@ghost
Copy link

ghost commented Jul 22, 2023

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-bot
Copy link

Most changes to Python require a NEWS entry.

Please add it using the blurb_it web app or the blurb command-line tool.

Copy link
Member

@vsajip vsajip left a comment

Choose a reason for hiding this comment

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

I've suggested a few tweaks.

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@vsajip
Copy link
Member

vsajip commented Jul 22, 2023

Hi @evildmp , I think our reviews crossed. Hopefully @JochemBoersma can use the best of both sets of suggestions.

JochemBoersma and others added 3 commits July 22, 2023 16:07
@JochemBoersma
Copy link
Contributor Author

Hi @evildmp , I think our reviews crossed. Hopefully @JochemBoersma can use the best of both sets of suggestions.

Hi @vsajip . Thanks for review. To be honest, and for your information: for me the first time to contribute to a project.
We are having sprint sessions now at the EuroPython.

Copy link
Contributor

@evildmp evildmp left a comment

Choose a reason for hiding this comment

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

This looks good to me. (It can always be further improved of course.)

@JochemBoersma
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

@vsajip: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from vsajip July 22, 2023 14:40
@vsajip vsajip merged commit 5e5a34a into python:main Jul 22, 2023
@vsajip vsajip added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 22, 2023
@miss-islington
Copy link
Contributor

Thanks @JochemBoersma for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington
Copy link
Contributor

Thanks @JochemBoersma for the PR, and @vsajip for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-107065 is a backport of this pull request to the 3.12 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 22, 2023
@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 22, 2023
@bedevere-bot
Copy link

GH-107066 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 22, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 22, 2023
vsajip pushed a commit that referenced this pull request Jul 22, 2023
vsajip pushed a commit that referenced this pull request Jul 22, 2023
@bedevere-bot
Copy link

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot ARM Raspbian 3.x has failed when building commit 5e5a34a.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/424/builds/4501) and take a look at the build logs.
  4. Check if the failure is related to this commit (5e5a34a) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/424/builds/4501

Summary of the results of the build (if available):

== Tests result: ENV CHANGED ==

427 tests OK.

10 slowest tests:

  • test_venv: 9 min 57 sec
  • test_gdb: 8 min 45 sec
  • test_largefile: 8 min 36 sec
  • test_compileall: 7 min 28 sec
  • test_math: 4 min 31 sec
  • test_multiprocessing_spawn: 4 min
  • test_concurrent_futures: 3 min 9 sec
  • test_pathlib: 2 min 33 sec
  • test_peg_generator: 2 min 13 sec
  • test_hashlib: 2 min 12 sec

1 test altered the execution environment:
test_concurrent_futures

19 tests skipped:
test.test_asyncio.test_windows_events
test.test_asyncio.test_windows_utils test_devpoll test_idle
test_ioctl test_kqueue test_launcher test_perf_profiler
test_startfile test_tcl test_tkinter test_ttk test_ttk_textonly
test_turtle test_winconsoleio test_winreg test_winsound test_wmi
test_zipfile64

Total duration: 37 min 22 sec

Click to see traceback logs
remote: Enumerating objects: 15, done.        
remote: Counting objects:   6% (1/15)        
remote: Counting objects:  13% (2/15)        
remote: Counting objects:  20% (3/15)        
remote: Counting objects:  26% (4/15)        
remote: Counting objects:  33% (5/15)        
remote: Counting objects:  40% (6/15)        
remote: Counting objects:  46% (7/15)        
remote: Counting objects:  53% (8/15)        
remote: Counting objects:  60% (9/15)        
remote: Counting objects:  66% (10/15)        
remote: Counting objects:  73% (11/15)        
remote: Counting objects:  80% (12/15)        
remote: Counting objects:  86% (13/15)        
remote: Counting objects:  93% (14/15)        
remote: Counting objects: 100% (15/15)        
remote: Counting objects: 100% (15/15), done.        
remote: Compressing objects:  12% (1/8)        
remote: Compressing objects:  25% (2/8)        
remote: Compressing objects:  37% (3/8)        
remote: Compressing objects:  50% (4/8)        
remote: Compressing objects:  62% (5/8)        
remote: Compressing objects:  75% (6/8)        
remote: Compressing objects:  87% (7/8)        
remote: Compressing objects: 100% (8/8)        
remote: Compressing objects: 100% (8/8), done.        
remote: Total 8 (delta 7), reused 0 (delta 0), pack-reused 0        
From https://github.com/python/cpython
 * branch                  main       -> FETCH_HEAD
Note: switching to '5e5a34ac3a827e040cd89426b1774fec2123336a'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 5e5a34ac3a gh-107028: tiny textual changes in logging docs and docstrings (GH-107029)
Switched to and reset branch 'main'

./Modules/_testcapi/heaptype_relative.c: In function ‘make_sized_heaptypes’:
./Modules/_testcapi/heaptype_relative.c:62:28: warning: cast from pointer to integer of different size [-Wpointer-to-int-cast]
   62 |                            (unsigned long long)data_ptr,
      |                            ^

make: *** [Makefile:2021: buildbottest] Error 3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants