Skip to content

Docstring typos #47788

Closed
Closed

Description

@Rambo007
mannequin
BPO 3538
Nosy @birkenfeld

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2008-08-10.22:46:32.158>
created_at = <Date 2008-08-10.22:16:33.287>
labels = ['invalid', 'docs']
title = 'Docstring typos'
updated_at = <Date 2008-08-11.08:18:16.326>
user = 'https://bugs.python.org/Rambo007'

bugs.python.org fields:

activity = <Date 2008-08-11.08:18:16.326>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-08-10.22:46:32.158>
closer = 'gpolo'
components = ['Documentation']
creation = <Date 2008-08-10.22:16:33.287>
creator = 'Rambo007'
dependencies = []
files = []
hgrepos = []
issue_num = 3538
keywords = []
message_count = 3.0
messages = ['70996', '70997', '71002']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'gpolo', 'Rambo007']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue3538'
versions = ['Python 3.0', 'Python 3.1']

Activity

  1. Rambo007 commented on Aug 10, 2008

    Rambo007mannequin
    MannequinAuthor

    Hello. I was pokinf around in the Python 3.0b2 interpreter and I found
    some typos in the following doctring:

    >>> import sys; print(sys.platform.__doc__)
    str(string[, encoding[, errors]]) -> str

    Create a new string object from the given encoded string.
    encoding defaults to the current default string encoding.
    errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.

    Please fix the docstring words 'encoding' and 'errors' to have the
    capital initial letter, so that the docstring would look like this:
    str(string[, encoding[, errors]]) -> str

    Create a new string object from the given encoded string.
    Encoding defaults to the current default string encoding.
    Errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.

    Please fix other similar typos if you find them. Thank you.

  2. gpolo commented on Aug 10, 2008

    gpolomannequin
    Mannequin

    'encoding' and 'errors' refers to the names of the arguments accepted by
    str, this is not a typo.

  3. birkenfeld commented on Aug 11, 2008

    @birkenfeld
    Member

    Chester, please stop changing your user name and wasting our time.

  4. transferred this issue fromon Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dir

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions