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: packaging.pypi.simple docs use both client and crawler name, which might be confusing
Type: Stage: resolved
Components: Distutils2, Documentation Versions: Python 3.3
process
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: eric.araujo Nosy List: alexis, docs@python, eric.araujo, gruszczy
Priority: normal Keywords: patch

Created on 2011-06-17 18:16 by gruszczy, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
12354.patch gruszczy, 2011-06-17 18:20 review
Messages (7)
msg138538 - (view) Author: Filip Gruszczyński (gruszczy) Date: 2011-06-17 18:16
In documentation for packaging.pypi.simple in first code snippet crawler variable is created on which further operations will be performed. However in all next snippets there is client variable, which is a little confusing on first sight. This could be consistent throughout the whole page.
msg138539 - (view) Author: Filip Gruszczyński (gruszczy) Date: 2011-06-17 18:20
And a small, quick patch to docs.
msg138540 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-06-17 18:22
Thanks for the report.  I’m editing the doc to fix all instances of client and also improve phrasing in the whole file.
msg138985 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-06-24 21:03
Doc update in 8de5fe3b1696
msg162056 - (view) Author: Petri Lehtinen (petri.lehtinen) * (Python committer) Date: 2012-06-01 08:26
Can this be closed?
msg162091 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-06-01 18:08
Not yet; the commit was adding missing doc to the Crawler class, but I haven’t reviewed the use of client vs. crawler yet.

Alexis, you introduced the client/crawler naming after reading some book; what do you think now?
msg162344 - (view) Author: Alexis Metaireau (alexis) * (Python triager) Date: 2012-06-05 14:01
> Alexis, you introduced the client/crawler naming after reading some book; what do you think now?

Making the distinction between a crawler and a client is probably not a 
good idea since it introduces two concepts instead of one simple one.

We have indexes and different ways to access them: What about having an 
"XMLRPCClient" and a "SimpleClient"?

In addition, having a simpler API, something like 
packaging.indexes.get_client('simple' OR 'xmlrpc') can be useful, but 
that's a different issue.
History
Date User Action Args
2022-04-11 14:57:18adminsetgithub: 56563
2014-03-13 04:26:05eric.araujosetstatus: open -> closed
resolution: out of date
stage: resolved
2012-06-05 14:14:17petri.lehtinensetnosy: - petri.lehtinen
2012-06-05 14:01:33alexissetmessages: + msg162344
2012-06-01 18:08:34eric.araujosetstatus: pending -> open

messages: + msg162091
title: packaging.pypi.simple docs use both client and crawler variable, which might be confusing -> packaging.pypi.simple docs use both client and crawler name, which might be confusing
2012-06-01 08:59:35petri.lehtinensetstatus: open -> pending
2012-06-01 08:26:10petri.lehtinensetnosy: + petri.lehtinen
messages: + msg162056
2011-06-24 21:03:10eric.araujosetmessages: + msg138985
2011-06-17 18:22:34eric.araujosetassignee: docs@python -> eric.araujo
messages: + msg138540
2011-06-17 18:20:12gruszczysetfiles: + 12354.patch
keywords: + patch
messages: + msg138539
2011-06-17 18:16:14gruszczycreate