All, * I've just noticed that the page describing RecordArrays (http://www.scipy.org/RecordArrays) is not listed under the Cookbook: should this be changed ? Shouldn't there be at least a link in the documentation page ? * Same problem with Subclasses (http://www.scipy.org/Subclasses) * I was eventually considering writing down some basic docs for MaskedArrays: should I create a page under the Cookbook ? Elsewhere ? * Congrats for the DocMarathon initiative ! The 3 points I've just raised would fit nicely with objective #3 (reference sections): what's the plan for that ? Any specific directions to follow ?
Hi Pierre 2008/5/19 Pierre GM <pgmdevlist@gmail.com>:
* I've just noticed that the page describing RecordArrays (http://www.scipy.org/RecordArrays) is not listed under the Cookbook: should this be changed ? Shouldn't there be at least a link in the documentation page ?
How about we add those pages to a CookBookCategory and auto-generate the Cookbook (like I've done with ProposedEnhancements)?
* I was eventually considering writing down some basic docs for MaskedArrays: should I create a page under the Cookbook ? Elsewhere ?
That's a good place for now. Use ReST (on the wiki, use {{{#!rst <your stuff here> }}}), then we can incorporate your work into the user guide later. Regards Stéfan
Where is the "CookBookCategory"? I'm afraid I don't understand that reference below. Are there plans to auto-generate the content in the Cookbook Recipes (http://www.scipy.org/Cookbook) or is it still reasonable for me to edit those pages? Thanks, Chris On Mon, May 19, 2008 at 10:02 AM, Stéfan van der Walt <stefan@sun.ac.za> wrote:
Hi Pierre
2008/5/19 Pierre GM <pgmdevlist@gmail.com>:
* I've just noticed that the page describing RecordArrays (http://www.scipy.org/RecordArrays) is not listed under the Cookbook: should this be changed ? Shouldn't there be at least a link in the documentation page ?
How about we add those pages to a CookBookCategory and auto-generate the Cookbook (like I've done with ProposedEnhancements)?
* I was eventually considering writing down some basic docs for MaskedArrays: should I create a page under the Cookbook ? Elsewhere ?
That's a good place for now. Use ReST (on the wiki, use {{{#!rst <your stuff here> }}}), then we can incorporate your work into the user guide later.
Regards Stéfan _______________________________________________ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
-- Christopher Burns Computational Infrastructure for Research Labs 10 Giannini Hall, UC Berkeley phone: 510.643.4014 http://cirl.berkeley.edu/
Hi Chris 2008/6/11 Christopher Burns <cburns@berkeley.edu>:
Where is the "CookBookCategory"? I'm afraid I don't understand that reference below. Are there plans to auto-generate the content in the Cookbook Recipes (http://www.scipy.org/Cookbook) or is it still reasonable for me to edit those pages?
The list is already generated at the bottom of Cookbook. To make a page show up there, add the following lines to the bottom (excluding the triple-quotes): """ ---- CategoryCookbook """ I suggest adding your page to the descriptive list at the top of Cookbook too. Regards Stéfan
Excellent, thanks Stefan! On Tue, Jun 10, 2008 at 3:31 PM, Stéfan van der Walt <stefan@sun.ac.za> wrote:
Hi Chris
2008/6/11 Christopher Burns <cburns@berkeley.edu>:
Where is the "CookBookCategory"? I'm afraid I don't understand that reference below. Are there plans to auto-generate the content in the Cookbook Recipes (http://www.scipy.org/Cookbook) or is it still reasonable for me to edit those pages?
The list is already generated at the bottom of Cookbook. To make a page show up there, add the following lines to the bottom (excluding the triple-quotes):
""" ---- CategoryCookbook """
I suggest adding your page to the descriptive list at the top of Cookbook too.
Regards Stéfan _______________________________________________ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
participants (3)
-
Christopher Burns -
Pierre GM -
Stéfan van der Walt