On Sun, Jul 4, 2010 at 2:05 PM, dffdgsdfgsdfhjhtre wrote:
> There are two types of documentation, "reference" documentation
> (articles explaining all about one specific object such as slugify or
> the Feed class), and "topical" documentation (articles explaining how
> to do stuff like write templ
On Sun, 2010-07-04 at 18:41 -0700, dffdgsdfgsdfhjhtre wrote:
> On Jul 4, 8:40 pm, Luke Plant wrote:
> > Unlike PHP, we have namespaces, which means that providing a list of
> > every function/class is a different matter.
>
> So? Matplotlib has similar documentation to PHP's reference, and it's
>
As an 'intermediate' django user from time to time I need to look at
the Django code to fill out gaps in the documentation. I think this is
fine: "use the sourse, Luke" has always been a Python thing. But it
would be nice if developers could describe each parameter to the
function/method. This des
On Jul 4, 8:40 pm, Luke Plant wrote:
> Unlike PHP, we have namespaces, which means that providing a list of
> every function/class is a different matter.
So? Matplotlib has similar documentation to PHP's reference, and it's
fairly well regarded. The one thing that matplotlib doesn't do well is
th
On Sun, 2010-07-04 at 10:05 -0700, dffdgsdfgsdfhjhtre wrote:
> There are two types of documentation, "reference" documentation
> (articles explaining all about one specific object such as slugify or
> the Feed class), and "topical" documentation (articles explaining how
> to do stuff like write tem
On Jul 4, 7:38 pm, Flávio Amieiro wrote:
> On Sun, Jul 4, 2010 at 8:29 PM, dffdgsdfgsdfhjhtre wrote:
>
> > I may be in the minority here, but I believe grepping source should
> > never, ever, ever be an acceptable substitution for proper
> > documentation.
>
> I agree with you here. As I said, I d
On Sun, Jul 4, 2010 at 8:29 PM, dffdgsdfgsdfhjhtre wrote:
> I may be in the minority here, but I believe grepping source should
> never, ever, ever be an acceptable substitution for proper
> documentation.
>
I agree with you here. As I said, I don't think this workflow should be
imposed
on everyo
On Jul 4, 2:22 pm, Flávio Amieiro wrote:
> For this kind of problem, i just grep django's code for the string I want. I
> know that not everyone likes to do this
I may be in the minority here, but I believe grepping source should
never, ever, ever be an acceptable substitution for proper
documen
On Sun, Jul 4, 2010 at 2:05 PM, dffdgsdfgsdfhjhtre wrote:
> There are two types of documentation, "reference" documentation
> (articles explaining all about one specific object such as slugify or
> the Feed class), and "topical" documentation (articles explaining how
> to do stuff like write templ
On Sun, Jul 4, 2010 at 12:05 PM, dffdgsdfgsdfhjhtre wrote:
> It seems right now, django's documentation is trying to do both at the
> same time. One project that does reference documentation really well,
> imo, is PHP. For example: http://us3.php.net/preg_replace Say what you
> will about PHP, but
There are two types of documentation, "reference" documentation
(articles explaining all about one specific object such as slugify or
the Feed class), and "topical" documentation (articles explaining how
to do stuff like write templates).
It seems right now, django's documentation is trying to do
11 matches
Mail list logo