Skip to content

Document timeout arguments to poll() in select module #86023

Closed

Description

@zaneb
mannequin
BPO 41857
Nosy @taleinat, @zaneb
PRs
  • bpo-41857: Document timeout arguments in select module #22406
  • [3.10]bpo-41857: Document timeout arguments in select module (GH-22406) #30741
  • [3.9]bpo-41857: Document timeout arguments in select module (GH-22406) #30742
  • 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 2022-01-21.09:38:43.503>
    created_at = <Date 2020-09-25.02:00:00.849>
    labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
    title = 'Document timeout arguments to poll() in select module'
    updated_at = <Date 2022-01-21.09:38:43.502>
    user = 'https://github.com/zaneb'

    bugs.python.org fields:

    activity = <Date 2022-01-21.09:38:43.502>
    actor = 'taleinat'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2022-01-21.09:38:43.503>
    closer = 'taleinat'
    components = ['Documentation']
    creation = <Date 2020-09-25.02:00:00.849>
    creator = 'zaneb'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 41857
    keywords = ['patch']
    message_count = 5.0
    messages = ['377473', '411053', '411099', '411101', '411102']
    nosy_count = 3.0
    nosy_names = ['taleinat', 'docs@python', 'zaneb']
    pr_nums = ['22406', '30741', '30742']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'enhancement'
    url = 'https://bugs.python.org/issue41857'
    versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    Activity

    1. zaneb commented on Sep 25, 2020

      zanebmannequin
      MannequinAuthor

      The select.poll.poll() and select.devpoll.poll() methods don't have their timeout arguments documented in their docstrings. In both cases the argument is in milliseconds, whereas the timeout arguments to select.kqueue.control() and select.epoll.poll() are in seconds, and are documented in the docstring.

    2. added
      docsDocumentation in the Doc dir
      type-featureA feature request or enhancement
      on Sep 25, 2020
    3. taleinat commented on Jan 20, 2022

      @taleinat
      Contributor

      New changeset 27df756 by Zane Bitter in branch 'main':
      bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
      27df756

    4. taleinat commented on Jan 21, 2022

      @taleinat
      Contributor

      New changeset f6e5972 by Tal Einat in branch '3.10':
      [3.10] bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
      f6e5972

    5. taleinat commented on Jan 21, 2022

      @taleinat
      Contributor

      New changeset 656971e by Tal Einat in branch '3.9':
      [3.9] bpo-41857: mention timeout argument units in select.poll() and select.depoll() doc-strings (GH-22406)
      656971e

    6. taleinat commented on Jan 21, 2022

      @taleinat
      Contributor

      Thanks for this improvement, Zane!

    7. 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

      3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation 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