Skip to content

gh-138178: Doc: Clarify that range is an immutable sequence #138184

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

Closed
wants to merge 7 commits into from
+1 −1
Closed

gh-138178: Doc: Clarify that range is an immutable sequence #138184

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
65451a6
Clarify host and port parameter behavior in smtplib.SMTP_SSL initiali…
Aniketsy Aug 3, 2025
7337b6d
Clarify host and port parameter behavior in smtplib.SMTP_SSL initiali…
Aniketsy Aug 3, 2025
54907a0
Clarify smtplib docs: host/port explanation
Aniketsy Aug 19, 2025
058ab0a
Doc: Add iterator reference and anchor to range() documentation
Aniketsy Aug 27, 2025
a1e470b
Doc: Add iterator reference and anchor to range() documentation
Aniketsy Aug 27, 2025
3f553c0
Doc: Add iterator reference and anchor to range() documentation
Aniketsy Aug 27, 2025
771dafc
Doc: Add iterator reference and anchor to range() documentation
Aniketsy Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Doc/library/functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1736,7 +1736,9 @@ are always available. They are listed here in alphabetical order.
Rather than being a function, :class:`range` is actually an immutable
sequence type, as documented in :ref:`typesseq-range` and :ref:`typesseq`.


The object returned by :class:`range` is an :term:`iterator` and supports iteration.
Copy link
Member

Choose a reason for hiding this comment

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

It's not totally correct to say "the object returned by range", because range itself is the object. Instead, we should say something like "the range type is an iterator".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for your feedback and corrections!

Copy link
Member

Choose a reason for hiding this comment

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

Or along the lines of "an instance of range is an iterator"?

Copy link
Member

Choose a reason for hiding this comment

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

That works too.

Copy link

Choose a reason for hiding this comment

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

This isn’t correct - range isn’t an iterator, it’s a sequence (though it is iterable). Note how you can iterate the same range object multiple times, and next() fails. There’s a separate range_iterator type, like list_iterator etc.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, yeah. Let's just say "range supports iteration" or something like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have update with this
The :class:range type is iterable and supports iteration.

Please let me know , if this needs further improvement .

See also :ref:`iterator` for more information about iterators and how to implement
custom iterable classes.
Copy link
Member

Choose a reason for hiding this comment

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

There are a lot of iterators throughout the documentation, but this makes it seem like range is special. I think we should remove this note -- the iterator term already contains lots of information about iterators.

.. function:: repr(object)

Return a string containing a printable representation of an object. For many
Expand Down