Skip to content

bpo-37342: Fix the incorrect nb_index's type in typeobj documentation #14241

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 5 commits into from
Jun 20, 2019
Merged

bpo-37342: Fix the incorrect nb_index's type in typeobj documentation #14241

merged 5 commits into from
Jun 20, 2019

Conversation

shihai1991
Copy link
Member

@shihai1991 shihai1991 commented Jun 19, 2019 •
edited by Mariatta
Loading

It was listed as binaryfunc. It should be unaryfunc.

@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jun 19, 2019
@shihai1991 shihai1991 changed the title bpo-37342: update the nb_index's type bpo-37342: update the nb_index's type in doc Jun 19, 2019
tirkarthi
tirkarthi approved these changes Jun 19, 2019
View reviewed changes
Copy link
Member

@tirkarthi tirkarthi left a comment

Choose a reason for hiding this comment

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

LGTM. It's listed as unaryfunc ".. c:member:: unaryfunc PyNumberMethods.nb_index" in https://github.com/python/cpython/blob/master/Doc/c-api/typeobj.rst line 2069.

@tirkarthi
Copy link
Member

tirkarthi commented Jun 19, 2019 •
edited
Loading

Please fix the CI error. I think the last column with "index" at https://travis-ci.org/python/cpython/jobs/547863960#L399 needs a space so that it's aligned with the rest of columns in the table as shown in the CI error log.

Edit: I think NEWS entry is not needed for this doc change

@shihai1991
Copy link
Member Author

Please fix the CI error. I think the last column with "index" at https://travis-ci.org/python/cpython/jobs/547863960#L399 needs a space so that it's aligned with the rest of columns in the table as shown in the CI error log.

Edit: I think NEWS entry is not needed for this doc change

Good catch. Let us try it ;)

Mariatta
Mariatta approved these changes Jun 20, 2019
View reviewed changes
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

Thanks. I confirmed it is unaryfunc in

cpython/Include/cpython/object.h

Line 136 in af41c56

unaryfunc nb_index;
. News file is not needed.

@Mariatta Mariatta changed the title bpo-37342: update the nb_index's type in doc bpo-37342: Fix the incorrect nb_index's type in typeobj documentation Jun 20, 2019
@miss-islington
Copy link
Contributor

@shihai1991: Status check is done, and it's a success ✅ .

@miss-islington miss-islington merged commit bc5caf8 into python:master Jun 20, 2019
@miss-islington
Copy link
Contributor

Thanks @shihai1991 for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 20, 2019
@shihai1991 @miss-islington
bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (…
27c4726 
…pythonGH-14241)

It was listed as `binaryfunc`. It should be `unaryfunc`.
(cherry picked from commit bc5caf8)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
@bedevere-bot
Copy link

GH-14254 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Jun 20, 2019
@miss-islington @shihai1991
bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (…
6258c1f 
…GH-14241)

It was listed as `binaryfunc`. It should be `unaryfunc`.
(cherry picked from commit bc5caf8)

Co-authored-by: Hai Shi <shihai1992@gmail.com>
@tirkarthi
Copy link
Member

Thank you @shihai1991

CuriousLearner added a commit to CuriousLearner/cpython that referenced this pull request Jun 21, 2019
@CuriousLearner
Merge branch 'master' into fix-issue24255
7bf6445 
* master: (599 commits)
  Docs: Improved phrasing (pythonGH-14069)
  Remove redundant if check from optional argument function in argparse. (pythonGH-8766)
  bpo-37289: Add a test for if with ifexpr in the peephole optimiser to detect regressions (pythonGH-14127)
  Update What's New in Python 3.9 (pythonGH-14253)
  bpo-36511: Improve ARM32 buildbot scripts (pythonGH-14251)
  bpo-37151: remove _PyCFunction_FastCallDict (pythonGH-14269)
  Fix typo, 'widger' -> 'widget', in idlelib/tree.py (pythonGH-14263)
  Fix bpo number in News file. (pythonGH-14260)
  bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (pythonGH-14241)
  Update What's New in Python 3.8 (pythonGH-14239)
  bpo-36710: Use tstate in pylifecycle.c (pythonGH-14249)
  Add missing single quote in io.TextIOWrapper.reconfigure documentation (pythonGH-14246)
  bpo-36511: Add buildbot scripts and fix tests for Windows ARM32 buildbot (pythonGH-13454)
  bpo-37333: Ensure IncludeTkinter has a value (pythonGH-14240)
  bpo-37331: Clarify format of socket handler messages in the documentation. (pythonGH-14234)
  bpo-37258: Not a bug, but added a unit test and updated documentation. (pythonGH-14229)
  bpo-36710: Remove PyImport_Cleanup() function (pythonGH-14221)
  Fix name of '\0'. (pythonGH-14222)
  bpo-36710: Add tstate parameter in import.c (pythonGH-14218)
  Document typing.ForwardRef (pythonGH-14216)
  ...
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@shihai1991 @lisroach
bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (…
386a43d 
…pythonGH-14241)

It was listed as `binaryfunc`. It should be `unaryfunc`.
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@shihai1991 @DinoV
bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (…
b1adac3 
…pythonGH-14241)

It was listed as `binaryfunc`. It should be `unaryfunc`.
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@tirkarthi tirkarthi tirkarthi approved these changes

@Mariatta Mariatta Mariatta approved these changes

Assignees
No one assigned
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.
6 participants
@shihai1991 @tirkarthi @miss-islington @bedevere-bot @Mariatta @the-knights-who-say-ni