fix typo in object.__format__ documentation #19504
Conversation
|
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA). Recognized GitHub usernameWe couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames: This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
There was a problem hiding this comment.
Thanks for the PR @hroskes and welcome!
Although this is just changing one word, I think this will require a CLA prior to merging since it's not something a spellchecker would be able to correct.
After 24-48 hours of signing the CLA, you can update the status on GitHub by looking yourself up in the CLA Assistant App. At that point, the label should change from cla not signed to cla signed, assuming the CLA was correctly processed.
| ``object.__format__(x, '')`` is now equivalent to ``str(x)`` rather | ||
| than ``format(str(self), '')``. | ||
| than ``format(str(x), '')``. |
There was a problem hiding this comment.
From looking over the bpo issue and PR, it looks like Serhiy got the above explanation and example implementation mixed up a bit. It could make sense if he were using an instance of object, such as obj with something like this:
``obj.__format__('') is now equivalent to ``str(self)`` rather
than ``format(str(self))``.
but when using the actual class object as the explanation is doing, it does not make as much sense IMO to refer to self.
So, I tentatively agree with the PR, but I would prefer if @serhiy-storchaka could give it a final look-over.
|
I am fairly confident that this change is correct and the CLA has been signed now, so I'll proceed with merging the PR. I'll take responsibility for reverting the change though if Serhiy thinks this is incorrect. |
|
Thanks again @hroskes. |
* 'master' of github.com:python/cpython: (2949 commits) Add files in tests/test_peg_generator to the install target lists (pythonGH-19723) bpo-40398: Fix typing.get_args() for special generic aliases. (pythonGH-19720) bpo-40348: Fix typos in the programming FAQ (pythonGH-19729) bpo-38387: Formally document PyDoc_STRVAR and PyDoc_STR macros (pythonGH-16607) bpo-40401: Remove duplicate pyhash.h include from pythoncore.vcxproj (pythonGH-19725) bpo-40387: Improve queue join() example. (pythonGH-19724) bpo-40396: Support GenericAlias in the typing functions. (pythonGH-19718) Fix typo in Lib/typing.py (pythonGH-19717) Fix typo in object.__format__ docs (pythonGH-19504) bpo-40275: Avoid importing logging in test.support (pythonGH-19601) bpo-40275: Avoid importing socket in test.support (pythonGH-19603) bpo-40275: Avoid importing asyncio in test.support (pythonGH-19600) bpo-40279: Add some error-handling to the module initialisation docs example (pythonGH-19705) closes bpo-40385: Remove Tools/scripts/checkpyc.py (pythonGH-19709) bpo-40334: Add What's New sections for PEP 617 and PEP 585 (pythonGH-19704) bpo-40340: Separate examples more clearly in the programming FAQ (pythonGH-19688) bpo-40360: Deprecate lib2to3 module in light of PEP 617 (pythonGH-19663) bpo-40334: Rewrite test_c_parser to avoid memory leaks (pythonGH-19694) bpo-38061: subprocess uses closefrom() on FreeBSD (pythonGH-19697) bpo-38061: os.closerange() uses closefrom() on FreeBSD (pythonGH-19696) ...
No description provided.