lazr-developers team mailing list archive

[Barry Warsaw <barry@xxxxxxxxxxxxx>]

On Mar 17, 2009, at 03:47 PM, Gary Poster wrote:

>OK, Barry and I agreed on a position yesterday evening (see https://dev.launchpad.net/LazrStyleGuide).  I have also been naughty and made a few other unrelated changes, because I am hopeful that this will be the last time I touch lazr.yourpkg in a while.
>
>- I made .bzrignore ignore *.egg-info.  This makes it easier to copy the file wholesale into legacy packages, which has been convenient.
>
>- I switched the tests to use the name ``additional_tests``.  This means that the setuptools testrunner can easily find them, and I configured the Zope testrunner to find them.
>
>- I added a ./bin/docs command that will generate Sphinx docs from the package.  This uses the package README.txt.  I used this to test that our plan to have a top-level README.txt and docs directories should work, but it is also a useful tool, so I left it in.
>
>- I removed the "or later" from the license statement, per Francis' comment.
>
>- I converted the doc test finder to use pkg_resources.
>
>- I removed basics.txt, putting the content in README.txt.

Rock.  This looks great.  One minor nit.

>=== modified file 'src/lazr/yourpkg/README.txt'
>--- src/lazr/yourpkg/README.txt	2009-01-10 01:00:49 +0000
>+++ src/lazr/yourpkg/README.txt	2009-03-17 15:17:14 +0000
>@@ -15,8 +15,31 @@
>     along with lazr.yourpkg.  If not, see <http://www.gnu.org/licenses/>.
> 
> LAZR yourpkg
>-***********
>-
>-This is a pure template for new lazr namespace packages.  Whenever you want to
>-make a new lazr subpackage, just branch this code and change all occurrences
>-of 'yourpkg' with whatever your subpackage's name is.
>+************
>+
>+This is a pure template for new lazr namespace packages.  
>+
>+Please see https://dev.launchpad.net/LazrStyleGuide and
>+https://dev.launchpad.net/Hacking for how to develop in this
>+package.
>+
>+This is an example Sphinx_ `Table of contents`_.  If you add files to the docs
>+directory, you should probably improve it.
>+
>+.. toctree::
>+   :glob:
>+
>+   *   
>+   docs/*
>+
>+.. _Sphinx: http://sphinx.pocoo.org/
>+.. _Table of contents: http://sphinx.pocoo.org/concepts.html#the-toc-tree
>+
>+Importable
>+==========
>+
>+The lazr.yourpkg package is importable, and has a version number.
>+
>+    >>> import lazr.yourpkg
>+    >>> print 'VERSION:', lazr.yourpkg.__version__
>+    VERSION: ...
>\ No newline at end of file

^^ oops.
-- 
https://code.launchpad.net/~gary/lazr.yourpkg/trunk/+merge/4477
Your team LAZR Developers is subscribed to branch lp:lazr.yourpkg.