Changeset 371 for trunk/SRC/ToBeReviewed/STRUCTURE

Timestamp:

08/07/08 11:32:02 (16 years ago)

Author:

pinsard

Message:

improvements of headers (alignments of IDL prompt in examples)

Location:

trunk/SRC/ToBeReviewed/STRUCTURE

Files:

• chkstru.pro (modified) (1 diff)
• extractstru.pro (modified) (1 diff)
• mixstru.pro (modified) (3 diffs)
• struct2string.pro (modified) (1 diff)
• where_tag.pro (modified) (1 diff)

trunk/SRC/ToBeReviewed/STRUCTURE/chkstru.pro

@@ -37 +37 @@
 ;
 ; @examples
-;        test = { a:1, b:2, c:3 }
-;        required = ['a','c']
-;        if CHKSTRU(test,required) then print,'found a and c.'
-;        IDL> print, CHKSTRU(test,'b')
+;
+;   IDL> test = { a:1, b:2, c:3 }
+;   IDL> required = ['a','c']
+;   IDL> if CHKSTRU(test,required) then print,'found a and c.'
+;   IDL> print, CHKSTRU(test,'b')
 ;           1
-;        IDL> print, CHKSTRU(test,'b',/extract)
+;   IDL> print, CHKSTRU(test,'b',/extract)
 ;               2
 ;

trunk/SRC/ToBeReviewed/STRUCTURE/extractstru.pro

@@ -25 +25 @@
 ; @examples
 ;
-;    IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 )
-;    IDL> help, extra,/struct
+;   IDL> extra=get_extra(/ok, year=1999, age_capitaine=35 )
+;   IDL> help, extra,/struct
 ;    ** Structure <83e66bc>, 3 tags, length=6, refs=1:
 ;       AGE_CAPITAINE   INT             35
 ;       OK              INT              1
 ;       YEAR            INT           1999
-;    IDL> help, extractstru(extra,['ok','hhuihi','YEAR']),/stru
+;   IDL> help, extractstru(extra,['ok','hhuihi','YEAR']),/stru
 ;    ** Structure <831afac>, 1 tags, length=2, refs=1:
 ;       AGE_CAPITAINE   INT             35
-;    IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/keep),/stru
+;   IDL> help, extractstru(extra,['ok','hhuihi','YEAR'],/keep),/stru
 ;    ** Structure <834bbc4>, 2 tags, length=4, refs=1:
 ;       OK              INT              1

trunk/SRC/ToBeReviewed/STRUCTURE/mixstru.pro

@@ -26 +26 @@
 ; @examples
 ;     
-;     IDL> a=get_extra(/toto,ok=123)
-;     IDL> b=get_extra(ok=111, year=1999, age_capitaine=35)
-;     IDL> help, a,b,/struct
+;   IDL> a=get_extra(/toto,ok=123)
+;   IDL> b=get_extra(ok=111, year=1999, age_capitaine=35)
+;   IDL> help, a,b,/struct
 ;     ** Structure <8334424>, 2 tags, length=4, refs=1:
 ;        OK              INT            123
@@ -36 +36 @@
 ;        OK              INT            111
 ;        YEAR            INT           1999
-;     IDL> help, mixstru(a,b),/struct
+;   IDL> help, mixstru(a,b),/struct
 ;     ** Structure <82f25ac>, 4 tags, length=8, refs=1:
 ;        AGE_CAPITAINE   INT             35
@@ -42 +42 @@
 ;        OK              INT            123
 ;        TOTO            INT              1
-;     IDL> help, mixstru(b,a),/struct
+;   IDL> help, mixstru(b,a),/struct
 ;     ** Structure <834604c>, 4 tags, length=8, refs=1:
 ;        TOTO            INT              1

trunk/SRC/ToBeReviewed/STRUCTURE/struct2string.pro

@@ -25 +25 @@
 ; @examples
 ;
-;      IDL> print, struct2string(!d)
+;   IDL> print, struct2string(!d)
 ;      create_struct('NAME','X','X_SIZE',891,'Y_SIZE',630,'X_VSIZE'
 ;      ,891,'Y_VSIZE',630,'X_CH_SIZE',6,'Y_CH_SIZE',10,'X_PX_CM'

trunk/SRC/ToBeReviewed/STRUCTURE/where_tag.pro

@@ -41 +41 @@
 ;
 ; @examples
-;       Suppose STR is a structure with tags CAT_NO:indgen(10), and 
-;               NAME:strarr(10).   Find the indices where STR.CAT_NO is
-;               between 3 and 5.
 ;
-;       IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] )  ;or
-;       IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5]) 
+; Suppose STR is a structure with tags CAT_NO:indgen(10), and 
+; NAME:strarr(10). Find the indices where STR.CAT_NO is between 3 and 5.
+;
+;   IDL> print, WHERE_TAG( str, TAG_NAME = 'CAT_NO', VALUE = [3,4,5] ) 
+; or
+;   IDL> print, WHERE_TAG( str, TAG_NUM = 0, RANGE = [3,5]) 
 ;
 ; @history