Opened 17 years ago

Closed 17 years ago

#67 closed defect (fixed)

header (documentation) ncdf_getmask changeset:272

Reported by: pinsard Owned by: somebody
Priority: minor Milestone: provide usefull and beautifull documentations
Component: component1 Version:
Keywords: idldoc header keyword documentation Cc:

Description

for changeset:272 commiter (Seb)

As you add a keyword in the calling sequence of ncdf_getmask in changeset:272, you should add at the same time documentation about it in the header of this file :

 ; @keyword INVMASK {type=++}
 ; description and usage

May be you can also change examples according to this modification.

For example, is this one still available (no INVMASK in this call) ?

IDL> mask = ncdf_getmask('meshmaskORCA2.nc', maskname = 'tmask')

or you can add a new example using this new keyword ...

Sorry I don't not yet if {required} or {optional} can be added in a keyword definition in the header ... I'll check.

Change History (1)

comment:1 Changed 17 years ago by smasson

  • Resolution set to fixed
  • Status changed from new to closed

Dear Francoise,

It is always nice to use ticket for communacation and pretend that thousand of people will read what we are saying!!

the header part related to inmask was already there :
; @keyword INVMASK {default=0}{type=scalar: 0 or 1}
; Inverse the land/sea mask (that should have 0/1 values for land/sea): mask = 1-mask

for the example... yes I could add something...

Note: See TracTickets for help on using tickets.