Improve Doc/library/xmlrpc.client.rst

[serhiy-storchaka]

BPO	26889
Nosy	@terryjreedy, @serhiy-storchaka
Files	docs_xmlrpc_client.patch docs_xmlrpc_client_2.patch

^{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-05-07.05:46:29.419>
created_at = <Date 2016-04-29.21:39:15.781>
labels = ['type-feature', 'docs']
title = 'Improve Doc/library/xmlrpc.client.rst'
updated_at = <Date 2016-05-07.07:07:28.400>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2016-05-07.07:07:28.400>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-05-07.05:46:29.419>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2016-04-29.21:39:15.781>
creator = 'serhiy.storchaka'
dependencies = []
files = ['42656', '42763']
hgrepos = []
issue_num = 26889
keywords = ['patch']
message_count = 7.0
messages = ['264524', '265006', '265013', '265039', '265041', '265042', '265043']
nosy_count = 5.0
nosy_names = ['effbot', 'terry.reedy', 'docs@python', 'python-dev', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26889'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6']

[serhiy-storchaka]

Proposed patch makes minor improvements of Doc/library/xmlrpc.client.rst.

[terryjreedy]

This is my first reading of this doc. The formatting improvements look good. A definite enhancement.

Review contains a few comments. My main difficulty is separating creation of a proxy instance from use of a proxy instance. Some of the creation parameters govern the use, and hence do not make must sense until one reads the instance description a few paragraphs further on.
Perhaps the initial sentence "A :class:`ServerProxy` instance is an object that manages communication with aremote XML-RPC server." should be expanded into a paragraph with some of the description given later.

[serhiy-storchaka]

Thank you for your review Terry. Updated patch addresses most of your comments. But I'm unable to expand ServerProxy description as you suggest. May you can do this? My purpose was modest. Just fix some incorrect and outdated sentences. Then I fixed some formatting. I was not going and is not able to do anything besides this. I will take all that you offer.

[terryjreedy]

The corrected link works. I agree with deleting a bad sentence if you cannot fix it. I think you can go ahead and apply as is.

[python-dev]

New changeset 04250fc723e6 by Serhiy Storchaka in branch '3.5':
Issue bpo-26889: Tweaked xmlrpc.client documentation.
https://hg.python.org/cpython/rev/04250fc723e6

New changeset 9bdec549bad3 by Serhiy Storchaka in branch 'default':
Issue bpo-26889: Tweaked xmlrpc.client documentation.
https://hg.python.org/cpython/rev/9bdec549bad3

New changeset fb5bd513751f by Serhiy Storchaka in branch '2.7':
Issue bpo-26889: Tweaked xmlrpclib documentation.
https://hg.python.org/cpython/rev/fb5bd513751f

[serhiy-storchaka]

Thank you Terry.

[python-dev]

New changeset 52924d962027 by Serhiy Storchaka in branch '3.5':
Issue bpo-26889: Fixed hyperlinks formatting.
https://hg.python.org/cpython/rev/52924d962027

New changeset ea9d69a4d0fe by Serhiy Storchaka in branch 'default':
Issue bpo-26889: Fixed hyperlinks formatting.
https://hg.python.org/cpython/rev/ea9d69a4d0fe

New changeset 29a927c524cb by Serhiy Storchaka in branch '2.7':
Issue bpo-26889: Fixed hyperlinks formatting.
https://hg.python.org/cpython/rev/29a927c524cb