GeezerVison

mpage changed the title ~~gn-125897: FIx the range function refering to step as a kwarg~~ gh-125897: FIx the range function refering to step as a kwarg

bedevere-app Bot mentioned this pull request

Built-in function range params discrepancy across versions #125897

Closed

mpage changed the title ~~gh-125897: FIx the range function refering to step as a kwarg~~ gh-125897: Fix the range function refering to step as a kwarg

skirpichev reviewed

View reviewed changes

Comment thread

Doc/library/functions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.


          gh-125897: Fix the range function refering to step as a kwarg

26e2f2c

Addresses the #125897 documentation discrepancy that the range function accepts step as a kwarg

skirpichev commented Oct 25, 2024

Copy link

Copy Markdown

Member

@kbaikov, please avoid force-pushes: https://devguide.python.org/getting-started/pull-request-lifecycle

kbaikov and nineteendo reacted with thumbs up emoji

All reactions

👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

skirpichev approved these changes

View reviewed changes

bedevere-app Bot added awaiting core review and removed awaiting review labels

travis-pds reviewed

gh-131885: Updates docs to make max and min iterable param positional only #131868

View reviewed changes

Comment thread

Doc/library/functions.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

kbaikov commented Dec 9, 2024

Copy link

Copy Markdown

Contributor Author

A friendly ping. Is there any decision on this issue/PR? How do i proceed?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

skirpichev commented Feb 6, 2025

Copy link

Copy Markdown

Member

CC @nedbat

Perhaps, https://devguide.python.org/documentation/style-guide/#function-signatures requires a clarification. Is this for new code? How we should handle current sphinx docs, that use funny square bracket syntax?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

merwok changed the title ~~gh-125897: Fix the range function refering to step as a kwarg~~ gh-125897: Fix range function doc referring to step as a kwarg

Feb 24, 2025

skirpichev mentioned this pull request

Mar 29, 2025

Merged

skirpichev mentioned this pull request

Aug 10, 2025

gh-137609: Update signatures of builtins in the documentation #137610

Merged

terryjreedy approved these changes

View reviewed changes

terryjreedy left a comment •

edited

Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

In #137610, Serhiy proposes to put /s everywhere they belong, and I strongly support this. HIs PR #137609 includes the 2 additions here, so he also approves them. I think that this should be merged first so that OP gets the proper credit.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

bedevere-app Bot added awaiting merge and removed awaiting core review labels

AA-Turner approved these changes

View reviewed changes

Comment thread

Doc/library/functions.rst

		.. class:: range(stop)
		range(start, stop, step=1)
		.. class:: range(stop, /)
		range(start, stop, step=1, /)

AA-Turner Aug 11, 2025

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I think enumerating all three cases is slightly nicer. The step argument is for advanced use-cases. Thoguhts @terryjreedy?

Suggested change

	range(start, stop, step=1, /)
	range(start, stop, /)
	range(start, stop, step, /)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

terryjreedy Aug 11, 2025

Copy link

Copy Markdown

Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I generally prefer fewer lines, partly from experience with IDLE call tips (which would be similar in other IDEs). Serhiy generally went with fewer in his PR, as he did here, except where really needed. Two are really needed here, since the true Python-implementaton signature (start_or_stop, stop_if_needed=None, step=1, /) is definitely too baroque for the doc.

Given your approval, I will merge this and backport (as Serhiy plans to backport his changes).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

AA-Turner reacted with thumbs up emoji

All reactions

👍 1 reaction

terryjreedy added needs backport to 3.13

only security fixes

needs backport to 3.14 bugs and security fixes labels

AA-Turner changed the title ~~gh-125897: Fix range function doc referring to step as a kwarg~~ gh-125897: Use positional-only parameter indicators for range()

AA-Turner changed the title ~~gh-125897: Use positional-only parameter indicators for range()~~ gh-125897: Use positional-only parameter indicators for range()

terryjreedy merged commit 0c83daa into python:main

github-project-automation Bot moved this from Todo to Done in Docs PRs

miss-islington-app Bot commented Aug 11, 2025

Copy link

Copy Markdown

Thanks @kbaikov for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the awaiting merge label

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request


          pythongh-125897: Mark range function parameters as positional only (p…

45ea51a

…ythonGH-125945)

(cherry picked from commit 0c83daa)

Co-authored-by: Konstantin Baikov <[email protected]>

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request


          pythongh-125897: Mark range function parameters as positional only (p…

5bea319

…ythonGH-125945)

(cherry picked from commit 0c83daa)

Co-authored-by: Konstantin Baikov <[email protected]>

bedevere-app Bot commented Aug 11, 2025

Copy link

Copy Markdown

GH-137652 is a backport of this pull request to the 3.14 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label

bedevere-app Bot commented Aug 11, 2025

Copy link

Copy Markdown

GH-137653 is a backport of this pull request to the 3.13 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label

AA-Turner pushed a commit that referenced this pull request