fenics team mailing list archive

[Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>]

On 30 August 2010 16:16, Marie Rognes <meg@xxxxxxxxx> wrote:
> On 30. aug. 2010 16:07, Kristian Ølgaard wrote:
>> On 30 August 2010 15:56, Marie Rognes <meg@xxxxxxxxx> wrote:
>>
>>> On 30. aug. 2010 15:53, Kristian Ølgaard wrote:
>>>
>>>> On 30 August 2010 15:26, Marie Rognes <meg@xxxxxxxxx> wrote:
>>>>
>>>>
>>>>> On 30. aug. 2010 15:01, Kristian Ølgaard wrote:
>>>>>
>>>>>
>>>>>> On 30 August 2010 14:41, Marie Rognes <meg@xxxxxxxxx> wrote:
>>>>>>
>>>>>>
>>>>>>
>>>>>>> On 30. aug. 2010 14:34, Kristian Ølgaard wrote:
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>> ---------- Forwarded message ----------
>>>>>>>> From: Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>
>>>>>>>> Date: 30 August 2010 14:33
>>>>>>>> Subject: Re: [Branch ~fenics-core/fenics-doc/main] Rev 113: * Moved
>>>>>>>> "style guides"/"before committing" paragraphs to before
>>>>>>>> To: noreply@xxxxxxxxxxxxx
>>>>>>>>
>>>>>>>>
>>>>>>>> On 30 August 2010 14:02,  <noreply@xxxxxxxxxxxxx> wrote:
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>> ------------------------------------------------------------
>>>>>>>>> revno: 113
>>>>>>>>> committer: Marie E. Rognes <meg@xxxxxxxxx>
>>>>>>>>> branch nick: fenics-doc
>>>>>>>>> timestamp: Mon 2010-08-30 13:53:09 +0200
>>>>>>>>> message:
>>>>>>>>>  * Moved "style guides"/"before committing" paragraphs to before
>>>>>>>>>    "creating patch/branch" in developer information
>>>>>>>>>
>>>>>>>>>  * Proof-read styleguides page.
>>>>>>>>>
>>>>>>>>>  Comments:
>>>>>>>>>
>>>>>>>>>  - This page is long. Maybe it could be split in two: a documenting
>>>>>>>>>    code and a documenting documentation page?
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>> You mean the styleguide page? It's more formatting/layout than
>>>>>>>> documenting. The first part is how the format the C++ and Python
>>>>>>>> source code for DOLFIN, FFC, UFC, UFL etc. The second part is more of
>>>>>>>> a quick ref for reST and how to write documentation structure, what
>>>>>>>> directives to use and how.
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>> Yes, I did understand that :) However, the page is still long. Could it
>>>>>>> be split in its two parts?
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>> The problem is in which toctree we should include it? I don't think we
>>>>>> can fit more on the front page without cluttering the layout, and
>>>>>> another 'index layer' in the styleguides is also not that elegant.
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>> I think we can afford another index layer in the styleguides: I don't
>>>>> think the average user will use that page everyday.  But it is not a big
>>>>> deal for me -- so if you prefer not to -- I won't push it ;)
>>>>>
>>>>>
>>>> I added this, I think it works better, what do you think?.
>>>>
>>>>
>>>>
>>> Right now it looks very odd (File not found) Did you forget adding some
>>> files?
>>>
>> Yes, should be fixed now.
>>
>
>
> Looks nice :)

OK, I saw Anders made some changes to the old styleguides.rst while I
split it, so I'll incorporate those changes and make the move
permanent.

Kristian

> --
> Marie
>
>