Skip to content

dev task of documenting undocumented APIs #55174

Closed

Description

@brettcannon
BPO 10965
Nosy @brettcannon, @ezio-melotti, @merwok, @ericsnowcurrently, @willingc
Dependencies
  • bpo-10224: Build 3.x documentation using python3.x
  • 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 2016-07-22.19:50:50.042>
    created_at = <Date 2011-01-20.23:33:40.787>
    labels = ['type-feature', 'docs']
    title = 'dev task of documenting undocumented APIs'
    updated_at = <Date 2016-07-22.19:50:50.041>
    user = 'https://github.com/brettcannon'

    bugs.python.org fields:

    activity = <Date 2016-07-22.19:50:50.041>
    actor = 'brett.cannon'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2016-07-22.19:50:50.042>
    closer = 'brett.cannon'
    components = ['Documentation', 'Devguide']
    creation = <Date 2011-01-20.23:33:40.787>
    creator = 'brett.cannon'
    dependencies = ['10224']
    files = []
    hgrepos = []
    issue_num = 10965
    keywords = []
    message_count = 5.0
    messages = ['126662', '242453', '242487', '242490', '271018']
    nosy_count = 7.0
    nosy_names = ['brett.cannon', 'ezio.melotti', 'eric.araujo', 'docs@python', 'BreamoreBoy', 'eric.snow', 'willingc']
    pr_nums = []
    priority = 'low'
    resolution = 'out of date'
    stage = 'needs patch'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue10965'
    versions = ['Python 3.5']

    Activity

    1. brettcannon commented on Jan 20, 2011

      @brettcannon
      MemberAuthor

      Once the docs are built using Python 3, then the coverage results can be used by people wanting to contribute as something to do. Should also mention in the task that some APIs should probably be private: http://mail.python.org/pipermail/python-dev/2010-November/105476.html .

    2. self-assigned this
      on Jan 20, 2011
    3. added
      docsDocumentation in the Doc dir
      type-featureA feature request or enhancement
      on Jan 20, 2011
    4. removed their assignment
      on Jan 11, 2013
    5. BreamoreBoy commented on May 3, 2015

      BreamoreBoymannequin
      Mannequin

      Where do we stand on this as bpo-10224 has been closed as "out of date"?

    6. brettcannon commented on May 3, 2015

      @brettcannon
      MemberAuthor

      The issue is still valid and waiting for someone to submit a patch to the devguide.

    7. willingc commented on May 3, 2015

      @willingc
      Contributor

      Add key points from linked email in msg126662 to documentation section of the devguide.

      • provide developers guidance on how to document undocumented APIs
      • when and how to use __all__
      • include rules from the linked email
      • highlight "do no harm" to existing users as discussed in email
    8. brettcannon commented on Jul 22, 2016

      @brettcannon
      MemberAuthor
    9. 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