|
From: <ds...@us...> - 2008-06-07 20:49:21
|
Revision: 5414
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5414&view=rev
Author: dsdale
Date: 2008-06-07 13:49:18 -0700 (Sat, 07 Jun 2008)
Log Message:
-----------
updated outline
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-06 18:19:53 UTC (rev 5413)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-07 20:49:18 UTC (rev 5414)
@@ -32,12 +32,12 @@
mathtext Michael ? submitted John
fonts et al Michael ? no author ?
pyplot tut John submitted Eric ?
-usetex Darren ? no author ?
-configuration Darren ? preliminary ?
+usetex Darren has author ?
+configuration Darren preliminary ?
colormapping Perry ? no author Eric ?
win32 install Charlie ? no author ?
os x install Charlie ? no author ?
-linux install ? no author ?
+linux install Darren has author ?
artist api John submitted ?
event handling John submitted ?
navigation John submitted ?
@@ -46,9 +46,9 @@
ui - gtk ? no author ?
ui - wx ? no author ?
ui - tk ? no author ?
-ui - qt Darren ? no author ?
+ui - qt Darren has author ?
backend - pdf Jouni ? no author ?
-backend - ps Darren ? no author ?
+backend - ps Darren has author ?
backend - svg ? no author ?
backend - agg ? no author ?
backend - cairo ? no author ?
@@ -64,7 +64,8 @@
the artist John has author ?
transforms Michael submitted John
documenting mpl Darren submitted ?
-coding guide John submitted ?
+coding guide John submitted Eric (Darren
+suggests)?
and_much_more ? ? ?
=============================== ==================== =========== ===================
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ds...@us...> - 2008-06-07 21:02:26
|
Revision: 5415
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5415&view=rev
Author: dsdale
Date: 2008-06-07 14:02:24 -0700 (Sat, 07 Jun 2008)
Log Message:
-----------
updated doc outline
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-07 20:49:18 UTC (rev 5414)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-07 21:02:24 UTC (rev 5415)
@@ -15,13 +15,13 @@
contouring Eric ? no author Perry ?
quiver plots Eric ? no author ?
quadmesh ? no author ?
-images ? no author ?
+images ? no author Darren
histograms Manuel ? no author Erik Tollerud ?
bar / errorbar ? no author ?
-x-y plots ? no author ?
+x-y plots ? no author Darren
time series plots ? no author ?
date plots John has author ?
-working with data John has author ?
+working with data John has author Darren
custom ticking ? no author ?
masked data Eric ? no author ?
text ? no author ?
@@ -30,12 +30,12 @@
animation John has author ?
collections ? no author ?
mathtext Michael ? submitted John
-fonts et al Michael ? no author ?
+fonts et al Michael ? no author Darren
pyplot tut John submitted Eric ?
usetex Darren has author ?
configuration Darren preliminary ?
colormapping Perry ? no author Eric ?
-win32 install Charlie ? no author ?
+win32 install Charlie ? no author Darren
os x install Charlie ? no author ?
linux install Darren has author ?
artist api John submitted ?
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ef...@us...> - 2008-06-08 20:31:48
|
Revision: 5425
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5425&view=rev
Author: efiring
Date: 2008-06-08 13:31:47 -0700 (Sun, 08 Jun 2008)
Log Message:
-----------
update documentation outline
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-08 18:20:21 UTC (rev 5424)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-08 20:31:47 UTC (rev 5425)
@@ -12,10 +12,9 @@
=============================== ==================== =========== ===================
User's guide unit Author Status Reviewer
=============================== ==================== =========== ===================
-contouring Eric ? no author Perry ?
-quiver plots Eric ? no author ?
-quadmesh ? no author ?
-images ? no author Darren
+plotting 2-D arrays Eric has author Perry ? Darren
+colormapping Eric has author ?
+quiver plots Eric has author ?
histograms Manuel ? no author Erik Tollerud ?
bar / errorbar ? no author ?
x-y plots ? no author Darren
@@ -23,7 +22,7 @@
date plots John has author ?
working with data John has author Darren
custom ticking ? no author ?
-masked data Eric ? no author ?
+masked data Eric has author ?
text ? no author ?
patches ? no author ?
legends ? no author ?
@@ -31,10 +30,9 @@
collections ? no author ?
mathtext Michael ? submitted John
fonts et al Michael ? no author Darren
-pyplot tut John submitted Eric ?
+pyplot tut John submitted Eric
usetex Darren submitted ?
configuration Darren preliminary ?
-colormapping Perry ? no author Eric ?
win32 install Charlie ? no author Darren
os x install Charlie ? no author ?
linux install Darren has author ?
@@ -64,7 +62,7 @@
the artist John has author ?
transforms Michael submitted John
documenting mpl Darren submitted ?
-coding guide John submitted Eric ?
+coding guide John submitted Eric
and_much_more ? ? ?
=============================== ==================== =========== ===================
@@ -96,4 +94,4 @@
produce and checking their work, so don't be shy. You *do not* need
to be an expert in the subject you are editing -- you should know
something about it and be willing to read, test, give feedback and
-pester!
\ No newline at end of file
+pester!
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ef...@us...> - 2008-06-09 21:58:33
|
Revision: 5450
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5450&view=rev
Author: efiring
Date: 2008-06-09 14:58:30 -0700 (Mon, 09 Jun 2008)
Log Message:
-----------
Added review comments on coding_guide.rst to outline.rst
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-09 21:51:10 UTC (rev 5449)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-09 21:58:30 UTC (rev 5450)
@@ -120,3 +120,61 @@
#. There is still a TODO in the file to include a complete list of symbols
+coding guide (reviewed by EF)
+-----------------------------
+
+Mostly fine, just a few comments. Also, there are a couple
+of typos, but I would rather just edit those directly in
+another pass (if you don't happen to find them) than include
+them as formal review notes.
+
+#. Import recommendation for ma: given that the trunk is
+ requiring numpy 1.1, perhaps we should be consistent and
+ recommend the form::
+
+ import numpy.ma as ma
+
+ for use in the trunk.
+ A note about the difference between the two forms and the
+ history can stay in place, and the alternative form would
+ still be required for the maintenance branch, I presume.
+
+#. This is peripheral, but regarding the example::
+
+ mpl.rcParams['xtick.major.pad'] = 6
+
+ At least at the application level, I think we should move
+ towards using validation routinely when setting rcParams,
+ to reduce a source of hard-to-find bugs. I don't know to
+ what extent Darren's traits-based system takes care of
+ this, but if it does, that is a big point in its favor.
+ There are alternatives (e.g. building validation into the
+ rc() function and using that instead of setting the
+ dictionary entries directly), if necessary.
+
+#. You give the example::
+
+ import matplotlib.cbook as cbook
+
+ Should there also be a list of the standard variants like
+ ``mtransforms``? (And, again peripherally, I would
+ shorten that one to ``mtrans``.)
+
+#. The treatment of whitespace is split into two parts
+ separated by paragraphs on docstrings and line length;
+ this can be consolidated. It might be worth mentioning
+ the ``reindent.py`` and ``tabnanny.py`` utilities here.
+
+#. Minor question of literary style: should use of the first
+ person be avoided in most places? It is used, for
+ example, in the discussion of the automatic kwarg doc
+ generation. I don't mind leaving the first person in,
+ with the general understanding that it means you.
+
+#. Licenses: you might want to add a link to your
+ explanation of your BSD choice. Peripheral question: is
+ there any problem with basemap's inclusion of
+ sub-packages with the gamut of licenses, GPL to MIT?
+
+
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ds...@us...> - 2008-06-12 13:38:02
|
Revision: 5480
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5480&view=rev
Author: dsdale
Date: 2008-06-12 06:38:00 -0700 (Thu, 12 Jun 2008)
Log Message:
-----------
comments in the coding guide review
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-12 12:22:58 UTC (rev 5479)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-12 13:38:00 UTC (rev 5480)
@@ -168,6 +168,53 @@
rc() function and using that instead of setting the
dictionary entries directly), if necessary.
+ Darren notes:
+
+ Validation is actually built into RcParams. This was done
+ just prior to development of the traited config, validation is done using
+ the mechanisms developed in rcsetup. For example::
+
+ >>> rcParams['a.b']=1
+ ---------------------------------------------------------------------------
+ KeyError Traceback (most recent call last)
+
+ /home/darren/<ipython console> in <module>()
+
+ /usr/lib64/python2.5/site-packages/matplotlib/__init__.pyc in __setitem__(self, key, val)
+ 555 except KeyError:
+ 556 raise KeyError('%s is not a valid rc parameter.\
+ --> 557 See rcParams.keys() for a list of valid parameters.'%key)
+ 558
+ 559
+
+ KeyError: 'a.b is not a valid rc parameter.See rcParams.keys() for a list of valid parameters.'
+
+ also::
+
+ rcParams['text.usetex']=''
+ ---------------------------------------------------------------------------
+ ValueError Traceback (most recent call last)
+
+ /home/darren/<ipython console> in <module>()
+
+ /usr/lib64/python2.5/site-packages/matplotlib/__init__.pyc in __setitem__(self, key, val)
+ 551 instead.'% (key, alt))
+ 552 key = alt
+ --> 553 cval = self.validate[key](val)
+ 554 dict.__setitem__(self, key, cval)
+ 555 except KeyError:
+
+ /usr/lib64/python2.5/site-packages/matplotlib/rcsetup.pyc in validate_bool(b)
+ 56 elif b in ('f', 'n', 'no', 'off', 'false', '0', 0, False): return False
+ 57 else:
+ ---> 58 raise ValueError('Could not convert "%s" to boolean' % b)
+ 59
+ 60 def validate_bool_maybe_none(b):
+
+ ValueError: Could not convert "" to boolean
+
+
+
#. DONE - You give the example::
import matplotlib.cbook as cbook
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ds...@us...> - 2008-06-13 21:34:17
|
Revision: 5526
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5526&view=rev
Author: dsdale
Date: 2008-06-13 14:34:10 -0700 (Fri, 13 Jun 2008)
Log Message:
-----------
updated doc outline.rst
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-13 21:27:56 UTC (rev 5525)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-13 21:34:10 UTC (rev 5526)
@@ -61,7 +61,7 @@
the canvas John has author ?
the artist John has author ?
transforms Michael submitted John
-documenting mpl Darren submitted ?
+documenting mpl Darren submitted John, Eric, Mike?
coding guide John in review Eric
and_much_more ? ? ?
=============================== ==================== =========== ===================
@@ -238,67 +238,3 @@
explanation of your BSD choice. Peripheral question: is
there any problem with basemap's inclusion of
sub-packages with the gamut of licenses, GPL to MIT?
-
-
-usetex user's guide-- reviewed by JDH
--------------------------------------
-
-Review of :ref:`usetex-tutorial`:
-
-#. DONE - In the section on the ps distiller, you might mention that it is the
- rasterization which some users find objectionable, and the distiller pram
- (eg 6000) is a dpi setting for the rasterizer. Not everyone will
- immediately grasp the controversy surrounding dumping high res bitmaps into
- a ps file.
-
-#. DONE - ``= Possible Hangups =`` - this is moin, not rest. I have
- fixed this already, just wanted to point it out. Also, for everything but
- top level chapters, I refer ``Upper lower`` for section titles, eg
- ``Possible hangups``.
-
-#. DONE - in the troubleshooting section, could you add a FAQ showing how to
- find their .matplotlib dir (matplotlib.get_data_path) and link to
- it.
-
- I think you mean mpl.get_configdir. I added this to the faq/HOWTO, and
- linked to it from usetex.rst and customizing.rst. I also added the
- MPLCONFIGDIR environment variable to environment_variables_faq.rst.
-
- DONE - Also link to the PATH var and properly format
- ``text.latex.preample``.
-
- DONE - For the dirs, do we want `tex.cache` or
- ``tex.cache``? I've been using the latter. We could use rest
- specific markup for files and dirs, but I've been resisting goin
- whle hog onthe markup... But we may eventually decide that is the
- better choice.
-
- I think we should use the directive provided by sphinx::
-
- :file:`tex.cache`
-
- I don't think that looks too ugly in ascii, its clear what it means. If you
- don't like it, I think we should use::
-
- ``tex.cache``
-
- which is formatted most
- similarly to the :file: directive in html. Let me know if you don't want to
- use the file directive.
-
- - JDH: let's go with the file directive.
-
-#. DONE - try and use internal reference links for every section and be
- generous with the sections. Eg, I added a section headers and
- internal linka for the postscript and unicode sections (we will
- want to be able to refer people to these easily from FAQs and mail
- list posts, etc)::
-
- .. _usetex-postscript:
-
- Postscript options
- ==================
-
-Looks good!
-
-Thanks!
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ef...@us...> - 2008-06-17 21:01:46
|
Revision: 5586
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5586&view=rev
Author: efiring
Date: 2008-06-17 14:01:29 -0700 (Tue, 17 Jun 2008)
Log Message:
-----------
Accepted coding guide; deleted notes from outline.rst
Modified Paths:
--------------
trunk/matplotlib/doc/devel/outline.rst
Modified: trunk/matplotlib/doc/devel/outline.rst
===================================================================
--- trunk/matplotlib/doc/devel/outline.rst 2008-06-17 19:07:51 UTC (rev 5585)
+++ trunk/matplotlib/doc/devel/outline.rst 2008-06-17 21:01:29 UTC (rev 5586)
@@ -62,7 +62,7 @@
the artist John has author ?
transforms Michael submitted John
documenting mpl Darren submitted John, Eric, Mike?
-coding guide John in review Eric
+coding guide John complete Eric
and_much_more ? ? ?
=============================== ==================== =========== ===================
@@ -136,105 +136,3 @@
- Done. It's pretty extensive, thanks to STIX... - MGD
-coding guide (reviewed by EF)
------------------------------
-
-Mostly fine (see :ref:`coding-guide`), just a few comments.
-Also, there are a couple of typos, but I would rather just edit those
-directly in another pass (if you don't happen to find them) than
-include them as formal review notes.
-
-#. DONE - Import recommendation for ma: given that the trunk is
- requiring numpy 1.1, perhaps we should be consistent and
- recommend the form::
-
- import numpy.ma as ma
-
- for use in the trunk.
- A note about the difference between the two forms and the
- history can stay in place, and the alternative form would
- still be required for the maintenance branch, I presume.
-
-#. This is peripheral, but regarding the example::
-
- mpl.rcParams['xtick.major.pad'] = 6
-
- At least at the application level, I think we should move
- towards using validation routinely when setting rcParams,
- to reduce a source of hard-to-find bugs. I don't know to
- what extent Darren's traits-based system takes care of
- this, but if it does, that is a big point in its favor.
- There are alternatives (e.g. building validation into the
- rc() function and using that instead of setting the
- dictionary entries directly), if necessary.
-
- Darren notes:
-
- Validation is actually built into RcParams. This was done
- just prior to development of the traited config, validation is done using
- the mechanisms developed in rcsetup. For example::
-
- >>> rcParams['a.b']=1
- ---------------------------------------------------------------------------
- KeyError Traceback (most recent call last)
-
- /home/darren/<ipython console> in <module>()
-
- /usr/lib64/python2.5/site-packages/matplotlib/__init__.pyc in __setitem__(self, key, val)
- 555 except KeyError:
- 556 raise KeyError('%s is not a valid rc parameter.\
- --> 557 See rcParams.keys() for a list of valid parameters.'%key)
- 558
- 559
-
- KeyError: 'a.b is not a valid rc parameter.See rcParams.keys() for a list of valid parameters.'
-
- also::
-
- rcParams['text.usetex']=''
- ---------------------------------------------------------------------------
- ValueError Traceback (most recent call last)
-
- /home/darren/<ipython console> in <module>()
-
- /usr/lib64/python2.5/site-packages/matplotlib/__init__.pyc in __setitem__(self, key, val)
- 551 instead.'% (key, alt))
- 552 key = alt
- --> 553 cval = self.validate[key](val)
- 554 dict.__setitem__(self, key, cval)
- 555 except KeyError:
-
- /usr/lib64/python2.5/site-packages/matplotlib/rcsetup.pyc in validate_bool(b)
- 56 elif b in ('f', 'n', 'no', 'off', 'false', '0', 0, False): return False
- 57 else:
- ---> 58 raise ValueError('Could not convert "%s" to boolean' % b)
- 59
- 60 def validate_bool_maybe_none(b):
-
- ValueError: Could not convert "" to boolean
-
-
-
-#. DONE - You give the example::
-
- import matplotlib.cbook as cbook
-
- Should there also be a list of the standard variants like
- ``mtransforms``? (And, again peripherally, I would
- shorten that one to ``mtrans``.)
-
-#. DONE - The treatment of whitespace is split into two parts
- separated by paragraphs on docstrings and line length;
- this can be consolidated. It might be worth mentioning
- the ``reindent.py`` and ``tabnanny.py`` utilities here.
-
-#. DONE - (removed first person usage) - Minor question of literary
- style: should use of the first person be avoided in most places?
- It is used, for example, in the discussion of the automatic kwarg
- doc generation. I don't mind leaving the first person in, with the
- general understanding that it means you.
-
-#. DONE - Licenses: you might want to add a link to your
- explanation of your BSD choice. Peripheral question: is
- there any problem with basemap's inclusion of
- sub-packages with the gamut of licenses, GPL to MIT?
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|