Skip to content

Typo in array documentationΒ #76482

Closed
Closed

Description

@MaikRo
mannequin
BPO 32301
Nosy @stevendaprano

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 = None
closed_at = <Date 2017-12-13.11:06:50.185>
created_at = <Date 2017-12-13.10:13:31.334>
labels = ['type-feature', 'docs']
title = 'Typo in array documentation'
updated_at = <Date 2017-12-13.11:06:50.177>
user = 'https://bugs.python.org/MaikRo'

bugs.python.org fields:

activity = <Date 2017-12-13.11:06:50.177>
actor = 'steven.daprano'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-12-13.11:06:50.185>
closer = 'steven.daprano'
components = ['Documentation']
creation = <Date 2017-12-13.10:13:31.334>
creator = 'Maik Ro'
dependencies = []
files = []
hgrepos = []
issue_num = 32301
keywords = []
message_count = 2.0
messages = ['308195', '308197']
nosy_count = 3.0
nosy_names = ['steven.daprano', 'docs@python', 'Maik Ro']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32301'
versions = []

Activity

  1. MaikRo commented on Dec 13, 2017

    MaikRomannequin
    MannequinAuthor

    .. class:: array(typecode[, initializer])

    should be

    typecode, [initializer] - comma is in square brackets

  2. added
    docsDocumentation in the Doc dir
    type-featureA feature request or enhancement
    on Dec 13, 2017
  3. stevendaprano commented on Dec 13, 2017

    @stevendaprano
    Member

    The given version is correct: the comma is only required if the initializer is given. Your suggested version

    typecode, [initializer]
    

    implies that the comma is always required whether the initializer is given or not.

    If we want to be absolutely pedantic, we could write:

    .. class:: array(typecode[, [initializer]])
    

    as trailing commas are legal in function calls. But I don't think that makes for good documentation.

  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

No one assigned

    Labels

    docsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions