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

Provide proper documentation for list data type #56185

Closed
jonashaag mannequin opened this issue May 1, 2011 · 2 comments
Closed

Provide proper documentation for list data type #56185

jonashaag mannequin opened this issue May 1, 2011 · 2 comments
Labels
docs Documentation in the Doc dir

Comments

@jonashaag
Copy link
Mannequin

jonashaag mannequin commented May 1, 2011

BPO 11976
Nosy @birkenfeld, @jonashaag
Superseder
  • bpo-11975: Fix referencing of built-in types (list, int, ...)
  • 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 2011-05-01.20:31:47.216>
    created_at = <Date 2011-05-01.20:21:34.947>
    labels = ['docs']
    title = 'Provide proper documentation for list data type'
    updated_at = <Date 2011-05-01.20:31:47.215>
    user = 'https://github.com/jonashaag'

    bugs.python.org fields:

    activity = <Date 2011-05-01.20:31:47.215>
    actor = 'georg.brandl'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2011-05-01.20:31:47.216>
    closer = 'georg.brandl'
    components = ['Documentation']
    creation = <Date 2011-05-01.20:21:34.947>
    creator = 'jonash'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 11976
    keywords = []
    message_count = 2.0
    messages = ['134924', '134927']
    nosy_count = 3.0
    nosy_names = ['georg.brandl', 'jonash', 'docs@python']
    pr_nums = []
    priority = 'normal'
    resolution = 'duplicate'
    stage = None
    status = 'closed'
    superseder = '11975'
    type = None
    url = 'https://bugs.python.org/issue11976'
    versions = []

    @jonashaag
    Copy link
    Mannequin Author

    jonashaag mannequin commented May 1, 2011

    Provide a proper list method reference (like the one for dict, http://docs.python.org/library/stdtypes.html#dict).

    Right now, documentation about lists is spread over multiple topics (.rst files) and methods are documented in footnotes.

    Also, intersphinx-ing and list methods is not possible -- :meth:`list.foo` does not create any links due to missing documentation. This is also related to bpo-11975.

    @jonashaag jonashaag mannequin assigned docspython May 1, 2011
    @jonashaag jonashaag mannequin added the docs Documentation in the Doc dir label May 1, 2011
    @birkenfeld
    Copy link
    Member

    birkenfeld commented May 1, 2011

    I'd go as far and say it is a duplicate. :)

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    1 participant