MathGroup Archive 2010

[Date Index] [Thread Index] [Author Index]

Search the Archive

Re: Assertions in Mathematica?

  • To: mathgroup at smc.vnet.net
  • Subject: [mg113513] Re: Assertions in Mathematica?
  • From: "Nasser M. Abbasi" <nma at 12000.org>
  • Date: Sun, 31 Oct 2010 05:36:56 -0500 (EST)
  • References: <iaj4ob$n70$1@smc.vnet.net>
  • Reply-to: nma at 12000.org

On 10/31/2010 12:10 AM, kj wrote:
...

Can I also join in the rant about the documentations? :)

What I like to see more in documentations:

1. more examples, and more examples, and yet more examples.
2. more description, do not be too terse. Many times, a command will 
show one small example, and its output, with little words or description 
to help someone to understand it.

Also, Documentation should have more tutorials showing how to combine 
many commands together.

I also think the documentation should be written not by the developers 
themselves, but by non-programmers.

Because if the programmer writes the documentation of the software they 
know, they think something is 'obvious', and so they will short change 
the documentation.

I think the Mathematica documentation seems to be written by the same 
engineers who work on Mathematica itself, and these are very smart 
developers to start with, and they think every one is at their level of 
knowledge of Mathematica (subconsciously), so they might not describe 
the command fully.

So please add more examples and more details to the documentations. More 
is always better when it comes to help pages. Do not be like the unix 
man pages ;)

>
> ~kj
>

--Nasser


  • Prev by Date: Re: Assertions in Mathematica?
  • Next by Date: Re: Adding labels to a GraphicsGrid object
  • Previous by thread: Re: Assertions in Mathematica?
  • Next by thread: Determining the root of the characteristic equation for time series model