Skip to content

[3.9] bpo-46586: Fix more erroneous doc links to builtins (GH-31429) #92199

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

Merged
merged 1 commit into from
May 3, 2022
Merged

[3.9] bpo-46586: Fix more erroneous doc links to builtins (GH-31429) #92199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Doc/library/urllib.request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ The following attribute and methods should only be used by classes derived from

This method, if implemented, will be called by the parent
:class:`OpenerDirector`. It should return a file-like object as described in
the return value of the :meth:`open` of :class:`OpenerDirector`, or ``None``.
the return value of the :meth:`~OpenerDirector.open` method of :class:`OpenerDirector`, or ``None``.
Copy link
Member

Choose a reason for hiding this comment

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

It is not related to this PR, but if some item is mentioned multiple times in one paragrafph, I prefer to keep link only in one of them (usually at the first occurrence). :class:`!OpenerDirector` or ``OpenerDirector``. Too many duplicated links do not make the text more readable.

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes sense, will keep it in mind for the future.

It should raise :exc:`~urllib.error.URLError`, unless a truly exceptional
thing happens (for example, :exc:`MemoryError` should not be mapped to
:exc:`URLError`).
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/zipfile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ ZipFile Objects
compressed text files in :term:`universal newlines` mode.

.. versionchanged:: 3.6
:meth:`open` can now be used to write files into the archive with the
:meth:`ZipFile.open` can now be used to write files into the archive with the
``mode='w'`` option.

.. versionchanged:: 3.6
Expand Down