Re: Ending a code listing section with IDLdoc [message #73678] |
Mon, 22 November 2010 09:32  |
Michael Galloy
Messages: 1114 Registered: April 2006
|
Senior Member |
|
|
On 11/22/10 7:33 AM, Fabzou wrote:
> Hi again,
>
> I found out what the problem was: the indentation of my documentation
> was not consequent. Note for myself: it is important to follow a strict
> indentation in the file header, too.
>
> Sorry!
>
>
>
> On 11/22/2010 12:54 PM, Fabzou wrote:
>> Dear all,
>>
>> Probably this have been asked and solved many times but I could not find
>> the info...
>>
>> In my file header I want to write a "code formated section" using
>> markups like this:
>>
>> ; The structure is defined as::
>> ;
>> ; {ABS_Date,
>> ; year: 0L, Gregorian year
>> ; ...
>> ; }
>> ;
>>
>> And then I would like to write some standard text again without
>> formatting.
>>
>> How do I do that? Skipping lines or removing the indentation did not
>> work.
>>
>> Thanks in advance, and thanks to IDLdoc which is *right now*
>> revolutionizing the way I document my code
I'm glad you found the problem. Yes, the rst format is very particular
to indentation: keep the indentation consistent and use spaces not tabs.
For those following along, the comment should look something like:
; The structure is defined as::
;
; {ABS_Date,
; year: 0L, Gregorian year
; ...
; }
;
; More comments.
Mike
--
www.michaelgalloy.com
Research Mathematician
Tech-X Corporation
|
|
|