fenics team mailing list archive

[Anders Logg <logg@xxxxxxxxx>]

On Mon, Aug 30, 2010 at 02:14:27PM +0100, Garth N. Wells wrote:
> Is it deliberate that the function order in the programmer docs
> differs from the order in which functions are declared in the .h
> files?
>
> Garth

Yes. It's alphabetical in the documentation. It can easily be turned
off, just need to comment out the line that calls sort().

Any opinions on the order of functions? Alphabetical or as in the
code?

Another thing to discuss is the style of documentation. Mesh.h
currently does

  /// Get cell connectivity.
  ///
  /// *Returns*
  ///     An array of integers
  ///         Connectivity for all cells.
  ///

Note punctuation on the first line. This is different from what we've
done before.

--
Anders