Changeset 295 for trunk/SRC/ToBeReviewed/LECTURE

Timestamp:

09/25/07 12:16:00 (17 years ago)

Author:

pinsard

Message:

typo

Location:

trunk/SRC/ToBeReviewed/LECTURE

Files:

• litchamp.pro (modified) (1 diff)
• ncdf_lec.pro (modified) (3 diffs)
• read_ncdf.pro (modified) (3 diffs)
• xncdf_lec.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/LECTURE/litchamp.pro

@@ -24 +24 @@
 ;        -the order of elements (except the first) has not any importance.
 ;        -the other elements (except the first) are optional.
-;        -they are recognize by the first letter of their names:
-;             g  to update vargrid
-;             u  to update varunit
-;             e  to update varexp
-;             d  to update vardate
-;             n  to update varname
+;        -they are recognized by the first letter of their names:
+;             g  to update vargrid,
+;             u  to update varunit,
+;             e  to update varexp,
+;             d  to update vardate,
+;             n  to update varname,
 ;             m  to update valmask
 ;

trunk/SRC/ToBeReviewed/LECTURE/ncdf_lec.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; Give informations on a file net cdf and allows to recuperate
-; variables which are write in.
+; Give informations on a file netcdf and allows to recuperate
+; variables which are written in it.
 ;
 ; @categories
@@ -9 +9 @@
 ;
 ; @param NOM {in}{required}
-; Name of a file net cdf situated in the directory stipulated by iodir.
+; Name of a file netcdf located in the directory stipulated by iodir.
 ;
 ; @keyword ATT
-; 'global' or at the name of a variable. Allows to see all attributes
-; joined at a variable
+; 'global' or the name of a variable. Allows to see all attributes
+; associated to variable
 ;
 ; @keyword DIM
@@ -19 +19 @@
 ;
 ; @keyword VAR
-;       1) /var: Gove the list of dimensions.
-;       2) var='nom de variable': in this case the function send back the variable.
+;       1) /var: Give the list of dimensions.
+;       2) var='name_of_a_variable': in this case the function send back the variable.
 ;
 ; @keyword IODIR

trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro

@@ -47 +47 @@
 ;
 ; @keyword FILENAME {required}{type=string}
-; It contains he file's name.
+; It contains the file's name.
 ;
 ; @keyword INIT {default=0}{type=scalar: 0 or 1}
-; To call automatically initncdf with filename as input argument and thus
-; redefine all the grid parameters
+; To call automatically <pro>initncdf</pro> with filename as input argument 
+; and thus ; redefine all the grid parameters
 ;
 ; @keyword GRID
@@ -83 +83 @@
 ; @returns
 ; Structure readable by <pro>litchamp</pro> or an array if NOSTRUCT is activated.
-;
 ; @uses
 ; common.pro
@@ -283 +282 @@
   ENDELSE
 ;---------------------------------------------------------------------
-; We initializate ixmindta, iymindta if needed
+; We initialize ixmindta, iymindta if needed
 ;---------------------------------------------------------------------
   if n_elements(jpidta) EQ 0 THEN jpidta = jpiglo

trunk/SRC/ToBeReviewed/LECTURE/xncdf_lec.pro

@@ -2 +2 @@
 ;
 ; @file_comments
-; Reading of a Net Cdf file with widgets !
+; Reading of a NetCdf file with widgets
 ;
 ; @categories
@@ -34 +34 @@
 ; @keyword SHIFT {type=vector}{default=[0, 0,...]}
 ; A vector of integers, specifying for each dimension how much we have to shift it.
-; By default, it is [0,0,...]. See the function shift for more explanations. BEWARE,
+; By default, it is [0,0,...]. See the function <proidl>shift</proidl> for more explanations. BEWARE,
 ; the shift is done on the biggest array before a possible reduction determined
 ; by OFFSET and COUNT. On the other hand, it is done after the possible extraction
@@ -56 +56 @@
 ;
 ; @examples
-; help, xncdf_lec()
+; IDL> help, xncdf_lec()
 ;
 ; @history
@@ -127 +127 @@
 ;------------------------------------------------------------
    base1 = widget_base(base, /column, /align_center)
-   rien = widget_label(base1, value = 'Net Cdf filename', /align_center)
+   rien = widget_label(base1, value = 'NetCdf filename', /align_center)
    rien = widget_text(base1, value = name, /align_center, uvalue=1, /editable) ;File's name we can change
    rien = widget_label(base1, value = ' ') ; We jump a line