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.

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

bpo-44740: Lowercase "internet" and "web" where appropriate. #27378

Merged
merged 3 commits into from Jul 26, 2021
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
@@ -41,7 +41,7 @@ Using the Python issue tracker
==============================

Bug reports for Python itself should be submitted via the Python Bug Tracker
(https://bugs.python.org/). The bug tracker offers a Web form which allows
(https://bugs.python.org/). The bug tracker offers a web form which allows
pertinent information to be entered and submitted to the developers.

The first step in filing a report is to determine whether the problem has
@@ -113,7 +113,7 @@ to many different classes of problems.

The language comes with a large standard library that covers areas such as
string processing (regular expressions, Unicode, calculating differences between
files), Internet protocols (HTTP, FTP, SMTP, XML-RPC, POP, IMAP, CGI
files), internet protocols (HTTP, FTP, SMTP, XML-RPC, POP, IMAP, CGI
programming), software engineering (unit testing, logging, profiling, parsing
Python code), and operating system interfaces (system calls, filesystems, TCP/IP
sockets). Look at the table of contents for :ref:`library-index` to get an idea
@@ -20,7 +20,7 @@ library and will be able to skip this step.)

For third-party packages, search the `Python Package Index
<https://pypi.org>`_ or try `Google <https://www.google.com>`_ or
another Web search engine. Searching for "Python" plus a keyword or two for
another web search engine. Searching for "Python" plus a keyword or two for
your topic of interest will usually find something helpful.


@@ -32,7 +32,7 @@ A Note on IP Versions
---------------------

For readers that aren't particularly familiar with IP addressing, it's
important to know that the Internet Protocol is currently in the process
important to know that the internet protocol is currently in the process
This conversation was marked as resolved by felixxm

This comment has been minimized.

Loading
@terryjreedy

terryjreedy Jul 27, 2021
Member

I am not sure about this one.

This comment has been minimized.

Loading
@serhiy-storchaka

serhiy-storchaka Jul 27, 2021
Member

It is a proper name. Usually used as abbreviations IPv4 and IPv6. I think it should be titlecased.

of moving from version 4 of the protocol to version 6. This transition is
occurring largely because version 4 of the protocol doesn't provide enough
addresses to handle the needs of the whole world, especially given the
@@ -332,7 +332,7 @@ Dealing with handlers that block
.. currentmodule:: logging.handlers

Sometimes you have to get your logging handlers to do their work without
blocking the thread you're logging from. This is common in Web applications,
blocking the thread you're logging from. This is common in web applications,
though of course it also occurs in other scenarios.

A common culprit which demonstrates sluggish behaviour is the
@@ -45,7 +45,7 @@ likely to be other forms of IPC that are faster, but for
cross-platform communication, sockets are about the only game in town.

They were invented in Berkeley as part of the BSD flavor of Unix. They spread
like wildfire with the Internet. With good reason --- the combination of sockets
like wildfire with the internet. With good reason --- the combination of sockets
with INET makes talking to arbitrary machines around the world unbelievably easy
(at least compared to other schemes).

@@ -953,7 +953,7 @@ Borland/CodeGear C++
This subsection describes the necessary steps to use Distutils with the Borland
C++ compiler version 5.5. First you have to know that Borland's object file
format (OMF) is different from the format used by the Python version you can
download from the Python or ActiveState Web site. (Python is built with
download from the Python or ActiveState web site. (Python is built with
Microsoft Visual C++, which uses COFF as the object file format.) For this
reason you have to convert Python's library :file:`python25.lib` into the
Borland format. You can do this as follows:
@@ -73,7 +73,7 @@ When you write a new script, consider adding these lines::
cgitb.enable()

This activates a special exception handler that will display detailed reports in
the Web browser if any errors occur. If you'd rather not show the guts of your
the web browser if any errors occur. If you'd rather not show the guts of your
program to users of your script, you can have the reports saved to files
instead, with code like this::

@@ -350,7 +350,7 @@ There's one important rule: if you invoke an external program (via
:func:`os.system`, :func:`os.popen` or other functions with similar
functionality), make very sure you don't pass arbitrary strings received from
the client to the shell. This is a well-known security hole whereby clever
hackers anywhere on the Web can exploit a gullible CGI script to invoke
hackers anywhere on the web can exploit a gullible CGI script to invoke
arbitrary shell commands. Even parts of the URL or field names cannot be
trusted, since the request doesn't have to come from your form!

@@ -457,7 +457,7 @@ likely the traceback will end up in one of the HTTP server's log files, or be
discarded altogether.

Fortunately, once you have managed to get your script to execute *some* code,
you can easily send tracebacks to the Web browser using the :mod:`cgitb` module.
you can easily send tracebacks to the web browser using the :mod:`cgitb` module.
If you haven't done so already, just add the lines::

import cgitb
@@ -17,7 +17,7 @@ This module defines the class :class:`FTP` and a few related items. The
this to write Python programs that perform a variety of automated FTP jobs, such
as mirroring other FTP servers. It is also used by the module
:mod:`urllib.request` to handle URLs that use FTP. For more information on FTP
(File Transfer Protocol), see Internet :rfc:`959`.
(File Transfer Protocol), see internet :rfc:`959`.
This conversation was marked as resolved by felixxm

This comment has been minimized.

Loading
@terryjreedy

terryjreedy Jul 27, 2021
Member

Not sure because not sure why 'Internet' is present in reference.

This comment has been minimized.

Loading
@felixxm

felixxm Jul 27, 2021
Author Contributor

I was thinking about removing internet from this sentence, but the internet RFC-* pattern is used few times in docs. I can send subsequent PR.

This comment has been minimized.

Loading
@serhiy-storchaka

serhiy-storchaka Jul 27, 2021
Member

I think it is an adjective here and it is correct to lowercase it.


The default encoding is UTF-8, following :rfc:`2640`.

@@ -23,7 +23,7 @@
This module implements a common interface to many different secure hash and
message digest algorithms. Included are the FIPS secure hash algorithms SHA1,
SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2) as well as RSA's MD5
algorithm (defined in Internet :rfc:`1321`). The terms "secure hash" and
algorithm (defined in internet :rfc:`1321`). The terms "secure hash" and
"message digest" are interchangeable. Older algorithms were called message
digests. The modern term is secure hash.

@@ -20,7 +20,7 @@ Both the regular Netscape cookie protocol and the protocol defined by
:rfc:`2965` are handled. RFC 2965 handling is switched off by default.
:rfc:`2109` cookies are parsed as Netscape cookies and subsequently treated
either as Netscape or RFC 2965 cookies according to the 'policy' in effect.
Note that the great majority of cookies on the Internet are Netscape cookies.
Note that the great majority of cookies on the internet are Netscape cookies.
:mod:`http.cookiejar` attempts to follow the de-facto Netscape cookie protocol (which
differs substantially from that set out in the original Netscape specification),
including taking note of the ``max-age`` and ``port`` cookie-attributes
@@ -14,7 +14,7 @@

--------------

This module defines classes for implementing HTTP servers (Web servers).
This module defines classes for implementing HTTP servers (web servers).
This conversation was marked as resolved by felixxm

This comment has been minimized.

Loading
@terryjreedy

terryjreedy Jul 27, 2021
Member

(W/web servers) not really needed.



.. warning::
@@ -869,7 +869,7 @@ Running without a subprocess

By default, IDLE executes user code in a separate subprocess via a socket,
which uses the internal loopback interface. This connection is not
externally visible and no data is sent to or received from the Internet.
externally visible and no data is sent to or received from the internet.
If firewall software complains anyway, you can ignore it.

If the attempt to make the socket connection fails, Idle will notify you.
@@ -11,7 +11,7 @@ Internet Protocols and Support

.. index:: module: socket

The modules described in this chapter implement Internet protocols and support
The modules described in this chapter implement internet protocols and support
for related technology. They are all implemented in Python. Most of these
modules require the presence of the system-dependent module :mod:`socket`, which
is currently supported on most popular platforms. Here is an overview:
@@ -930,7 +930,7 @@ HTTPHandler
^^^^^^^^^^^

The :class:`HTTPHandler` class, located in the :mod:`logging.handlers` module,
supports sending logging messages to a Web server, using either ``GET`` or
supports sending logging messages to a web server, using either ``GET`` or
``POST`` semantics.


@@ -960,17 +960,17 @@ supports sending logging messages to a Web server, using either ``GET`` or

.. method:: emit(record)

Sends the record to the Web server as a URL-encoded dictionary. The
Sends the record to the web server as a URL-encoded dictionary. The
:meth:`mapLogRecord` method is used to convert the record to the
dictionary to be sent.

.. note:: Since preparing a record for sending it to a Web server is not
.. note:: Since preparing a record for sending it to a web server is not
the same as a generic formatting operation, using
:meth:`~logging.Handler.setFormatter` to specify a
:class:`~logging.Formatter` for a :class:`HTTPHandler` has no effect.
Instead of calling :meth:`~logging.Handler.format`, this handler calls
:meth:`mapLogRecord` and then :func:`urllib.parse.urlencode` to encode the
dictionary in a form suitable for sending to a Web server.
dictionary in a form suitable for sending to a web server.


.. _queue-handler:
@@ -987,7 +987,7 @@ supports sending logging messages to a queue, such as those implemented in the

Along with the :class:`QueueListener` class, :class:`QueueHandler` can be used
to let handlers do their work on a separate thread from the one which does the
logging. This is important in Web applications and also other service
logging. This is important in web applications and also other service
applications where threads servicing clients need to respond as quickly as
possible, while any potentially slow operations (such as sending an email via
:class:`SMTPHandler`) are done on a separate thread.
@@ -1053,7 +1053,7 @@ because it works hand-in-hand with :class:`QueueHandler`.

Along with the :class:`QueueHandler` class, :class:`QueueListener` can be used
to let handlers do their work on a separate thread from the one which does the
logging. This is important in Web applications and also other service
logging. This is important in web applications and also other service
applications where threads servicing clients need to respond as quickly as
possible, while any potentially slow operations (such as sending an email via
:class:`SMTPHandler`) are done on a separate thread.
@@ -9,16 +9,16 @@
--------------

Mailcap files are used to configure how MIME-aware applications such as mail
readers and Web browsers react to files with different MIME types. (The name
readers and web browsers react to files with different MIME types. (The name
"mailcap" is derived from the phrase "mail capability".) For example, a mailcap
file might contain a line like ``video/mpeg; xmpeg %s``. Then, if the user
encounters an email message or Web document with the MIME type
encounters an email message or web document with the MIME type
:mimetype:`video/mpeg`, ``%s`` will be replaced by a filename (usually one
belonging to a temporary file) and the :program:`xmpeg` program can be
automatically started to view the file.

The mailcap format is documented in :rfc:`1524`, "A User Agent Configuration
Mechanism For Multimedia Mail Format Information", but is not an Internet
Mechanism For Multimedia Mail Format Information", but is not an internet
standard. However, mailcap files are supported on most Unix systems.


@@ -6,7 +6,7 @@ Internet Data Handling
**********************

This chapter describes modules which support handling data formats commonly used
on the Internet.
on the internet.


.. toctree::
@@ -18,7 +18,7 @@

The :mod:`pydoc` module automatically generates documentation from Python
modules. The documentation can be presented as pages of text on the console,
served to a Web browser, or saved to HTML files.
served to a web browser, or saved to HTML files.

For modules, classes, functions and methods, the displayed documentation is
derived from the docstring (i.e. the :attr:`__doc__` attribute) of the object,
@@ -65,9 +65,9 @@ manner similar to the Unix :program:`man` command. The synopsis line of a
module is the first line of its documentation string.

You can also use :program:`pydoc` to start an HTTP server on the local machine
that will serve documentation to visiting Web browsers. :program:`pydoc -p 1234`
that will serve documentation to visiting web browsers. :program:`pydoc -p 1234`
will start a HTTP server on port 1234, allowing you to browse the
documentation at ``http://localhost:1234/`` in your preferred Web browser.
documentation at ``http://localhost:1234/`` in your preferred web browser.
Specifying ``0`` as the port number will select an arbitrary unused port.

:program:`pydoc -n <hostname>` will start the server listening at the given
@@ -15,7 +15,7 @@
--------------

The :mod:`smtplib` module defines an SMTP client session object that can be used
to send mail to any Internet machine with an SMTP or ESMTP listener daemon. For
to send mail to any internet machine with an SMTP or ESMTP listener daemon. For
details of SMTP and ESMTP operation, consult :rfc:`821` (Simple Mail Transfer
Protocol) and :rfc:`1869` (SMTP Service Extensions).

@@ -66,7 +66,7 @@ created. Socket addresses are represented as follows:
.. _host_port:

- A pair ``(host, port)`` is used for the :const:`AF_INET` address family,
where *host* is a string representing either a hostname in Internet domain
where *host* is a string representing either a hostname in internet domain
notation like ``'daring.cwi.nl'`` or an IPv4 address like ``'100.50.200.5'``,
and *port* is an integer.

@@ -640,7 +640,7 @@ The following functions all create :ref:`socket objects <socket-objects>`.

.. function:: create_connection(address[, timeout[, source_address]])

Connect to a TCP service listening on the Internet *address* (a 2-tuple
Connect to a TCP service listening on the internet *address* (a 2-tuple
``(host, port)``), and return the socket object. This is a higher-level
function than :meth:`socket.connect`: if *host* is a non-numeric hostname,
it will try to resolve it for both :data:`AF_INET` and :data:`AF_INET6`,
@@ -877,7 +877,7 @@ The :mod:`socket` module also offers various network-related services:

.. function:: getprotobyname(protocolname)

Translate an Internet protocol name (for example, ``'icmp'``) to a constant
Translate an internet protocol name (for example, ``'icmp'``) to a constant
suitable for passing as the (optional) third argument to the :func:`.socket`
function. This is usually only needed for sockets opened in "raw" mode
(:const:`SOCK_RAW`); for the normal socket modes, the correct protocol is chosen
@@ -886,7 +886,7 @@ The :mod:`socket` module also offers various network-related services:

.. function:: getservbyname(servicename[, protocolname])

Translate an Internet service name and protocol name to a port number for that
Translate an internet service name and protocol name to a port number for that
service. The optional protocol name, if given, should be ``'tcp'`` or
``'udp'``, otherwise any protocol will match.

@@ -895,7 +895,7 @@ The :mod:`socket` module also offers various network-related services:

.. function:: getservbyport(port[, protocolname])

Translate an Internet port number and protocol name to a service name for that
Translate an internet port number and protocol name to a service name for that
service. The optional protocol name, if given, should be ``'tcp'`` or
``'udp'``, otherwise any protocol will match.

@@ -15,7 +15,7 @@ There are four basic concrete server classes:

.. class:: TCPServer(server_address, RequestHandlerClass, bind_and_activate=True)

This uses the Internet TCP protocol, which provides for
This uses the internet TCP protocol, which provides for
continuous streams of data between the client and server.
If *bind_and_activate* is true, the constructor automatically attempts to
invoke :meth:`~BaseServer.server_bind` and
@@ -263,7 +263,7 @@ Server Objects
The address on which the server is listening. The format of addresses varies
depending on the protocol family;
see the documentation for the :mod:`socket` module
for details. For Internet protocols, this is a tuple containing a string giving
for details. For internet protocols, this is a tuple containing a string giving
the address, and an integer port number: ``('127.0.0.1', 80)``, for example.


@@ -1056,7 +1056,7 @@ Constants

Option for :func:`create_default_context` and
:meth:`SSLContext.load_default_certs`. This value indicates that the
context may be used to authenticate Web servers (therefore, it will
context may be used to authenticate web servers (therefore, it will
be used to create client-side sockets).

.. versionadded:: 3.4
@@ -1065,7 +1065,7 @@ Constants

Option for :func:`create_default_context` and
:meth:`SSLContext.load_default_certs`. This value indicates that the
context may be used to authenticate Web clients (therefore, it will
context may be used to authenticate web clients (therefore, it will
be used to create server-side sockets).

.. versionadded:: 3.4
@@ -267,10 +267,10 @@ The :mod:`test.support` module defines the following constants:

.. data:: INTERNET_TIMEOUT

Timeout in seconds for network requests going to the Internet.
Timeout in seconds for network requests going to the internet.

The timeout is short enough to prevent a test to wait for too long if the
Internet request is blocked for whatever reason.
internet request is blocked for whatever reason.

Usually, a timeout using :data:`INTERNET_TIMEOUT` should not mark a test as
failed, but skip the test instead: see
@@ -20,7 +20,7 @@ strings up in components (addressing scheme, network location, path etc.), to
combine the components back into a URL string, and to convert a "relative URL"
to an absolute URL given a "base URL."

The module has been designed to match the Internet RFC on Relative Uniform
The module has been designed to match the internet RFC on Relative Uniform
Resource Locators. It supports the following URL schemes: ``file``, ``ftp``,
``gopher``, ``hdl``, ``http``, ``https``, ``imap``, ``mailto``, ``mms``,
``news``, ``nntp``, ``prospero``, ``rsync``, ``rtsp``, ``rtspu``, ``sftp``,
@@ -1543,7 +1543,7 @@ some point in the future.

* The :func:`urlopen` and :func:`urlretrieve` functions can cause arbitrarily
long delays while waiting for a network connection to be set up. This means
that it is difficult to build an interactive Web client using these functions
that it is difficult to build an interactive web client using these functions
without using threads.

.. index::
@@ -19,7 +19,7 @@

This module provides a single class, :class:`RobotFileParser`, which answers
questions about whether or not a particular user agent can fetch a URL on the
Web site that published the :file:`robots.txt` file. For more details on the
web site that published the :file:`robots.txt` file. For more details on the
structure of :file:`robots.txt` files, see http://www.robotstxt.org/orig.html.


@@ -1,8 +1,8 @@
:mod:`webbrowser` --- Convenient Web-browser controller
:mod:`webbrowser` --- Convenient web-browser controller
=======================================================

.. module:: webbrowser
:synopsis: Easy-to-use controller for Web browsers.
:synopsis: Easy-to-use controller for web browsers.

.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
@@ -12,7 +12,7 @@
--------------

The :mod:`webbrowser` module provides a high-level interface to allow displaying
Web-based documents to users. Under most circumstances, simply calling the
web-based documents to users. Under most circumstances, simply calling the
:func:`.open` function from this module will do the right thing.

Under Unix, graphical browsers are preferred under X11, but text-mode browsers
Loading
Loading