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.

Sign up for GitHub

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

Jump to bottom

Add docstring to io.IOBase.writelines #80704

Closed
MarcinNiemira mannequin opened this issue Apr 4, 2019 · 6 comments
Closed

Add docstring to io.IOBase.writelines #80704

MarcinNiemira mannequin opened this issue Apr 4, 2019 · 6 comments
Labels
3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir

Comments

@MarcinNiemira
Copy link
Mannequin

MarcinNiemira mannequin commented Apr 4, 2019

BPO 36523
Nosy @terryjreedy, @methane, @vadmium
PRs
  • bpo-36523: Add docstring to io.IOBase.writelines #12683
  • [3.7] bpo-36523: Add docstring to io.IOBase.writelines (GH-12683) #12905
    		•

    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 2019-04-22.12:09:08.135>
created_at = <Date 2019-04-04.08:03:57.554>
labels = ['3.7', '3.8', 'docs']
title = 'Add docstring to io.IOBase.writelines'
updated_at = <Date 2019-04-22.12:09:08.134>
user = 'https://bugs.python.org/MarcinNiemira'

    bugs.python.org fields:

    activity = <Date 2019-04-22.12:09:08.134>
actor = 'methane'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-04-22.12:09:08.135>
closer = 'methane'
components = ['Documentation']
creation = <Date 2019-04-04.08:03:57.554>
creator = 'Marcin Niemira'
dependencies = []
files = []
hgrepos = []
issue_num = 36523
keywords = ['patch']
message_count = 6.0
messages = ['339434', '339515', '339516', '340626', '340647', '340649']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'methane', 'docs@python', 'martin.panter', 'Marcin Niemira']
pr_nums = ['12683', '12905']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue36523'
versions = ['Python 3.7', 'Python 3.8']
    @MarcinNiemira
    Copy link
    Mannequin Author

    MarcinNiemira mannequin commented Apr 4, 2019

    Hey,

    There is a missing function doc in io.IOBase

    import os
help(io.IOBase.writelines)

    produces output like:

    Help on method_descriptor:

writelines(self, lines, /)

    I'll be happy to provide PR for this issue.

    Cheers,
    Marcin

    @MarcinNiemira MarcinNiemira mannequin added the 3.8 only security fixes label Apr 4, 2019
    @MarcinNiemira MarcinNiemira mannequin assigned docspython Apr 4, 2019
    @MarcinNiemira MarcinNiemira mannequin added the docs Documentation in the Doc dir label Apr 4, 2019
    @terryjreedy
    Copy link
    Member 

    Verified.  
>>> import io
>>> io.IOBase.writelines.__doc__
>>>

    @terryjreedy terryjreedy changed the title missing docs for IOBase writelines Add docstring to io.IOBase.writelines Apr 5, 2019
    @terryjreedy
    Copy link
    Member

    I assume that this can be backported even though it touches .c rather than .rst.

    @terryjreedy terryjreedy added the 3.7 (EOL) end of life label Apr 5, 2019
    @MarcinNiemira
    Copy link
    Mannequin Author

    MarcinNiemira mannequin commented Apr 22, 2019

    Hey,
    Is there something I can improve in this PR?

    @methane
    Copy link
    Member

    methane commented Apr 22, 2019

    New changeset ab86521 by Inada Naoki (Marcin Niemira) in branch 'master':
    bpo-36523: Add docstring to io.IOBase.writelines (GH-12683)
    ab86521

    @methane
    Copy link
    Member

    methane commented Apr 22, 2019

    New changeset 1100ae8 by Inada Naoki (Marcin Niemira) in branch '3.7':
    bpo-36523: Add docstring to io.IOBase.writelines (GH-12683)
    1100ae8

    @methane methane closed this as completed Apr 22, 2019
    @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
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life 3.8 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @methane @terryjreedy