This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: xmlrpc.client documentation (MultiCall Objects) points to a broken link
Type: Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, python-dev, sandro.tosi
Priority: normal Keywords:

Created on 2011-08-19 23:02 by sandro.tosi, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (4)
msg142504 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-08-19 23:02
following up http://mail.python.org/pipermail/docs/2011-March/003506.html , I verified that indeed

http://www.xmlrpc.com/discuss/msgReader$1208

is broken. I wrote to dave@scripting.com (the address you get when viewing http://www.xmlrpc.com/discuss/) on march and just now I re-wrote again, but I got no reply and the link is still broken.

I tried finding another source for the same doc, but it seems it's only available on xmlrpc.com (or some other dead links). I found, tho, the relative article on the wayback machine:

http://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic

Now, what should we do about this? remove the link completely? but then how can a user find information about multicalls? should we incorporate that article in our doc (do the licences allow us?)?

Cheers,
Sandro
msg142516 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-20 07:16
AFAIU xmlrpclib.MultiCall implements the technique described on the broken link, and the examples look pretty clear to me, so the user doesn't have to follow the link to understand how to use it.
I think it's good to keep a link around, in case the user wants to understand better how it works, but it could also be in a footnote.

This is what I would do:
  1) write something like "The xmlrpc.MultiCall object provides a way to  encapsulate multiple calls to a remote server into a single request¹."
  2) in the footnote write something like "[1]: This approach has been first presented in `a discussion on xmlrpc.com <link-to-web.archive.org>`_."

Possibly you could leave an rst comment explaining that the original link is down and that we are using the web.archive.org one until the page is back up.
FWIW http://www.xmlrpc.com/discuss/topics seems to work, and there are a few discussions from last month, but the links are broken.
msg142536 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-08-20 15:08
New changeset e8f878837eae by Sandro Tosi in branch '2.7':
#12787: link original MultiCall proposal to webarchive and in a footnote
http://hg.python.org/cpython/rev/e8f878837eae

New changeset ab11edca2310 by Sandro Tosi in branch '3.2':
#12787: link original MultiCall proposal to webarchive and in a footnote
http://hg.python.org/cpython/rev/ab11edca2310

New changeset 0fa18bc5427b by Sandro Tosi in branch 'default':
#12787: merge with 3.2
http://hg.python.org/cpython/rev/0fa18bc5427b
msg142537 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-08-20 15:10
Thanks Ezio for the suggestions.
History
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56996
2011-08-20 15:10:21sandro.tosisetstatus: open -> closed
resolution: fixed
messages: + msg142537

stage: needs patch -> resolved
2011-08-20 15:08:42python-devsetnosy: + python-dev
messages: + msg142536
2011-08-20 07:16:48ezio.melottisetmessages: + msg142516
2011-08-19 23:02:39sandro.tosicreate