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.

Sign up for GitHub

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

Jump to bottom

gh-95276: Add callable entry to the glossary #95738

Merged
merged 4 commits into from
Oct 12, 2022
Merged

gh-95276: Add callable entry to the glossary #95738

merged 4 commits into from
Oct 12, 2022

Conversation

MonadChains
Copy link
Contributor

@MonadChains MonadChains commented Aug 6, 2022 •
edited by bedevere-bot

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Aug 6, 2022
@TeamSpen210
Copy link

I think it’d be better to not mention tp_call, and instead describe calling as the actual syntax func(arg). tp_call is specific to CPython, confusing to pure-Python programmers (the most likely readers of the glossary), and as of PEP 590 (Vectorcall) is not entirely the arbiter of how calling behaves. Other similar glossary entries don’t seem to mention type slots either.

@AlexWaygood
Copy link
Member

Thanks for the PR, @MonadChains!

I agree with @TeamSpen210 — this seems too technical and implementation-specific for a glossary entry. A good glossary entry is quite tricky: it needs to be short, informative, and useful to total beginners in Python programming.

@AlexWaygood
Copy link
Member

We need to describe "what a callable is" (the implications and meaning of something being "callable" at the Python level) rather than how it is implemented in CPython.

@MonadChains
Copy link
Contributor Author

Thanks @TeamSpen210 and @AlexWaygood. I modified the entry to remove the implementation details.

@AlexWaygood AlexWaygood self-requested a review August 6, 2022 13:28
slateny
slateny reviewed Sep 25, 2022
View reviewed changes
Doc/glossary.rst Outdated Show resolved Hide resolved
JelleZijlstra
JelleZijlstra reviewed Oct 7, 2022
View reviewed changes
Doc/glossary.rst Outdated Show resolved Hide resolved
@JelleZijlstra JelleZijlstra self-assigned this Oct 7, 2022
@JelleZijlstra JelleZijlstra added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 12, 2022
@JelleZijlstra JelleZijlstra merged commit e3bf125 into python:main Oct 12, 2022
@miss-islington
Copy link
Contributor

Thanks @MonadChains for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 12, 2022
@MonadChains @miss-islington
pythongh-95276: Add callable entry to the glossary (pythonGH-95738)
4f62baf 
(cherry picked from commit e3bf125)

Co-authored-by: MonadChains <monadchains@gmail.com>
@bedevere-bot
Copy link

GH-98202 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 Oct 12, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 12, 2022
@MonadChains @miss-islington
pythongh-95276: Add callable entry to the glossary (pythonGH-95738)
82881e7 
(cherry picked from commit e3bf125)

Co-authored-by: MonadChains <monadchains@gmail.com>
@bedevere-bot
Copy link

GH-98203 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 12, 2022
miss-islington added a commit that referenced this pull request Oct 12, 2022
@miss-islington @MonadChains
gh-95276: Add callable entry to the glossary (GH-95738)
f94e6b4 
(cherry picked from commit e3bf125)

Co-authored-by: MonadChains <monadchains@gmail.com>
miss-islington added a commit that referenced this pull request Oct 12, 2022
@miss-islington @MonadChains
gh-95276: Add callable entry to the glossary (GH-95738)
9e666bc 
(cherry picked from commit e3bf125)

Co-authored-by: MonadChains <monadchains@gmail.com>
carljm added a commit to carljm/cpython that referenced this pull request Oct 14, 2022
@carljm
Merge branch 'main' into typewatch
6e53514 
* main: (38 commits)
  pythongh-98251: Allow venv to pass along PYTHON* variables to pip and ensurepip when they do not impact path resolution (pythonGH-98259)
  Bpo-41246: IOCP Proactor avoid callback code duplication (python#21399)
  bpo-46364: Use sockets for stdin of asyncio only on AIX (python#30596)
  pythongh-98178: syslog() is not thread-safe on macOS (python#98213)
  Mark all targets in `Doc/Makefile` as `PHONY` (pythonGH-98189)
  pythongh-97982: Factorize PyUnicode_Count() and unicode_count() code (python#98025)
  pythongh-96265: Formatting changes for faq/general (python#98129)
  tutorial: remove "with single quotes" (python#98204)
  pythongh-97669: Remove Tools/scripts/startuptime.py (python#98214)
  signalmodule.c uses _PyErr_WriteUnraisableMsg() (python#98217)
  pythongh-97669: Fix test_tools reference leak (python#98216)
  pythongh-97669: Create Tools/patchcheck/ directory (python#98186)
  pythongh-65046: Link to logging cookbook from asyncio docs (python#98207)
  Formatting fixes in contextlib docs (python#98111)
  pythongh-95276: Add callable entry to the glossary (python#95738)
  pythongh-96130: Rephrase use of "typecheck" verb for clarity (python#98144)
  Fix some incorrect indentation around the main switch (python#98177)
  pythongh-98172: Fix formatting in `except*` docs (python#98173)
  pythongh-97982: Remove asciilib_count() (python#98164)
  pythongh-95756: Free and NULL-out code caches when needed (pythonGH-98181)
  ...
carljm added a commit to carljm/cpython that referenced this pull request Oct 14, 2022
@carljm
Merge branch 'main' into cached_property
0bb0c69 
* main: (37 commits)
  pythongh-98251: Allow venv to pass along PYTHON* variables to pip and ensurepip when they do not impact path resolution (pythonGH-98259)
  Bpo-41246: IOCP Proactor avoid callback code duplication (python#21399)
  bpo-46364: Use sockets for stdin of asyncio only on AIX (python#30596)
  pythongh-98178: syslog() is not thread-safe on macOS (python#98213)
  Mark all targets in `Doc/Makefile` as `PHONY` (pythonGH-98189)
  pythongh-97982: Factorize PyUnicode_Count() and unicode_count() code (python#98025)
  pythongh-96265: Formatting changes for faq/general (python#98129)
  tutorial: remove "with single quotes" (python#98204)
  pythongh-97669: Remove Tools/scripts/startuptime.py (python#98214)
  signalmodule.c uses _PyErr_WriteUnraisableMsg() (python#98217)
  pythongh-97669: Fix test_tools reference leak (python#98216)
  pythongh-97669: Create Tools/patchcheck/ directory (python#98186)
  pythongh-65046: Link to logging cookbook from asyncio docs (python#98207)
  Formatting fixes in contextlib docs (python#98111)
  pythongh-95276: Add callable entry to the glossary (python#95738)
  pythongh-96130: Rephrase use of "typecheck" verb for clarity (python#98144)
  Fix some incorrect indentation around the main switch (python#98177)
  pythongh-98172: Fix formatting in `except*` docs (python#98173)
  pythongh-97982: Remove asciilib_count() (python#98164)
  pythongh-95756: Free and NULL-out code caches when needed (pythonGH-98181)
  ...
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @MonadChains @pablogsal
gh-95276: Add callable entry to the glossary (GH-95738)
37d1659 
(cherry picked from commit e3bf125)

Co-authored-by: MonadChains <monadchains@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JelleZijlstra JelleZijlstra JelleZijlstra left review comments

@slateny slateny slateny left review comments

@AlexWaygood AlexWaygood Awaiting requested review from AlexWaygood

@CAM-Gerlach CAM-Gerlach Awaiting requested review from CAM-Gerlach

Assignees

@JelleZijlstra JelleZijlstra

Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@MonadChains @TeamSpen210 @AlexWaygood @miss-islington @bedevere-bot @JelleZijlstra @slateny