Éric Araujo avatar Éric Araujo committed 2366875

Reject merge-author-email

Comments (0)

Files changed (2)

new-config-file.rst

 :Author: Éric Araujo <merwok@netwok.org>
 :Credits: Carl Meyer, folks at PyCon 2010, people in #distutils
 :License: PSF
-:Revision: 1.1
+:Revision: 1.2
 
 .. warning::
 
   [metadata]
   name = RestingParrot
   version = 0.6.4
-  author = Carl Meyer <carl@oddbird.net>
-  maintainer = Éric Araujo <merwok@netwok.org>
+  author = Carl Meyer
+  author-email = carl@oddbird.net
+  maintainer = Éric Araujo
+  maintainer-email = merwok@netwok.org
   summary = A sample project demonstrating distutils2 packaging
   description = README
   keywords = distutils2, packaging, sample project
 already defined. Consistency would win other convenience.
 
 
-Merge author and author-email
------------------------------
-:codename: merge-author-email
-
-Merge name and email in a single field for author (and maintainer)::
-
-  author = Carl Meyer <carl@oddbird.net>
-  maintainer = Éric Araujo <merwok@netwok.org>
-
-It is a common format, easy to parse (we do not support any valid :RFC:`2822`
-email field, just specifically ``name <email>``). :PEP:`345` :file:`METADATA`
-files separate author name and email, but for user-written :file:`setup.cfg`
-this format is nicer.
-
-
 Get description from a file
 ---------------------------
 :codename: desc-from-file
 ============================ ========================================
 description                  summary
 long_description             description (changed meaning)
-author                       author
-author_email                 merged with author
-maintainer                   maintainer
-maintainer_email             merged with maintainer
 url                          home-page
 N/A                          project-url
 every other metadata field   unchanged
 Appendix: Rejected ideas
 """"""""""""""""""""""""
 
+Merge author and author-email
+-----------------------------
+
+It was proposed to merge name and email in a single field for author (and
+maintainer)::
+
+  author = Carl Meyer <carl@oddbird.net>
+  maintainer = Éric Araujo <merwok@netwok.org>
+
+It is a common format, easy to parse (it’s not any valid :RFC:`2822` email
+field, just specifically ``name <email>``). The rationale was that while
+machine-generated and consumed :PEP:`345` :file:`METADATA` files were defined
+with separate author name and email fields, the user-written :file:`setup.cfg`
+could have some additional niceties. The Distutils maintainer voted this down
+for the sake of clarity: Field names in :file:`setup.cfg` are directly
+translated from :PEP:`345` without any complication. In a case like
+description__, there are real advantages in changing it in :file:`setup.cfg`,
+but this is not the case for author and author-email.
+
+.. __: `Get description from a file`_
+
+
 Get metadata from hooks
 -----------------------
 
 # these fields are specified in PEP 345
 name = RestingParrot
 version = 0.6.4
-author = Carl Meyer <carl@oddbird.net>
-maintainer = Éric Araujo <merwok@netwok.org>
+author = Carl Meyer
+author-email = carl@oddbird.net
+maintainer = Éric Araujo
+maintainer-email = merwok@netwok.org
 summary = A sample project demonstrating distutils2 packaging
 description = README
 keywords = distutils2, packaging, sample project
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.