[Bug 632554] Review Request: python-zope-component - Zope Component Architecture

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug.


https://bugzilla.redhat.com/show_bug.cgi?id=632554

--- Comment #7 from Chen Lei <supercyper1@xxxxxxxxx> 2010-09-17 03:28:08 EDT ---
(In reply to comment #5)
> They do no good in the modules directory -- no one is expecting to look for
> them there.  So if they aren't doing any good in %{_docdir} then you might as
> well just rm them.
> 
> To me they look like they're documenting usage of the API, though, which could
> be useful.  In your prior package it seemed like you were recreating part of
> the directory structure so it seemed that people wanting to know how to use the
> API were able to see which file mapped to which module.

It seems moving all .txt files to %{_docdir}/%{name}-%{version} directly is
inappropriate.

Take python-zope-schema for a example:

./README.txt
./src/zope/schema/README.txt
./src/zope/schema/sources.txt
./src/zope/schema/index.txt
./src/zope/schema/validation.txt
./src/zope/schema/fields.txt
./CHANGES.txt
./LICENSE.txt
./COPYRIGHT.txt

The contents of ./README.txt and ./src/zope/schema/README.txt are different, we
should not override ./README.txt with ./src/zope/schema/README.txt. 

>From fields.txt - "This document highlights unusual and subtle aspects of
various fields and field classes, and is not intended to be a general
introduction to schema fields.", so obviously this .txt file is not a API docs
for zope.schema package. It's normally useful when the developer want to take a
look at the code of the fields.py. 

I'm not sure if it'll be clearer to recreate the directory structure under
%{_docdir}[1] than just leaving those .txt files under module directory. 
It looks like those directory structures[1] are a bit complicated. I don't
intend to oppose moving text files to %{_docdir}, however I think leaving some
text files under python module directories is necessary and helpful[2].
Personally, I think leaving text files under %{_libdir}/python2.x/idlelib is
reasonable.

[1]
e.g.

%{_docdir}/python-zope-schema-%{version}/zope/schema

%{_docdir}/python-%{version}/idlelib


[2]
e.g.

cat /usr/lib/python2.7/site-packages/README
This directory exists so that 3rd party packages can be installed
here.  Read the source for site.py for more details.

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.
_______________________________________________
package-review mailing list
package-review@xxxxxxxxxxxxxxxxxxxxxxx
https://admin.fedoraproject.org/mailman/listinfo/package-review


[Index of Archives]     [Fedora Legacy]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite News]     [KDE Users]     [Fedora Tools]