[Checkins] SVN: bluebream/website/docs/v1.0/dev/decisions.rst one more decision (line length)

Baiju M baiju.m.mail at gmail.com
Mon Aug 9 12:54:48 EDT 2010


Log message for revision 115586:
  one more decision (line length)
  

Changed:
  U   bluebream/website/docs/v1.0/dev/decisions.rst

-=-
Modified: bluebream/website/docs/v1.0/dev/decisions.rst
===================================================================
--- bluebream/website/docs/v1.0/dev/decisions.rst	2010-08-09 16:47:45 UTC (rev 115585)
+++ bluebream/website/docs/v1.0/dev/decisions.rst	2010-08-09 16:54:48 UTC (rev 115586)
@@ -3,12 +3,11 @@
 
 - BlueBream is a "web framework".
 
-- Shortening BlueBream as Bream or BB is acceptable.  As of now, the
-  "BB" shortening is getting popular in community.
+- Shortening BlueBream as Bream or BB is acceptable.  As of now, the "BB"
+  shortening is getting popular in community.
 
-- There is only one public API exposed by "bluebream - the package"
-  This API is an entry point provided by setuptools which use
-  PasteScript::
+- There is only one public API exposed by "bluebream - the package" This API
+  is an entry point provided by setuptools which use PasteScript::
 
     entry_points={
     "paste.paster_create_template":
@@ -25,24 +24,25 @@
 
 - BlueBream 1.0 should provide an upgrade path from Zope 3.4 KGS.
 
-- Any "shell command" required to be repeated after project creation
-  should not be automated by the project template.
+- Any "shell command" required to be repeated after project creation should
+  not be automated by the project template.
 
-- Running ``bootstrap.py`` and ``buildout`` in the project should not
-  be done during project template creation for the previous reason.
-  Another supporting reason is the easiness of adding sources to
-  version control systems.
+- Running ``bootstrap.py`` and ``buildout`` in the project should not be
+  done during project template creation for the previous reason.  Another
+  supporting reason is the easiness of adding sources to version control
+  systems.
 
-- additional packages contained in namespaces such as "zc", "z3c", or
-  others will be added in the future, but won't be part of the 1.0
-  release.
+- additional packages contained in namespaces such as "zc", "z3c", or others
+  will be added in the future, but won't be part of the 1.0 release.
 
+- Use 76 as the maximum line length for documentation.  This is not a
+  hard-limit, it can be more that 76 for source code embedded within
+  documentation.  Tips for Emacs & VIM users: http://bit.ly/dpauyT
 
 .. raw:: html
 
   <div id="disqus_thread"></div><script type="text/javascript"
   src="http://disqus.com/forums/bluebream/embed.js"></script><noscript><a
-  href="http://disqus.com/forums/bluebream/?url=ref">View the
-  discussion thread.</a></noscript><a href="http://disqus.com"
-  class="dsq-brlink">blog comments powered by <span
-  class="logo-disqus">Disqus</span></a>
+  href="http://disqus.com/forums/bluebream/?url=ref">View the discussion
+  thread.</a></noscript><a href="http://disqus.com" class="dsq-brlink">blog
+  comments powered by <span class="logo-disqus">Disqus</span></a>



More information about the checkins mailing list