in preparation for beta9...

Dan Higgins higgins at nceas.ucsb.edu
Wed Jun 12 08:09:05 PDT 2002


Hi Chris (and everyone else),

    IMHO, modules with little or NO documentation are of questionable 
use. At this point, however, having ALL elements, etc documented with 
tooltip/summary/description/example/lineage info is not absolutely 
essential, while having a complete set of modules is highly desirable in 
order to understand the overall configuration of eml.

Dan Higgins
   

Christopher Jones wrote:

> Hi all,
>
> Since we've been making major changes to the current beta8 release of 
> EML, we've been falling behind in a large portion of the documentation 
> for the elements, attributes, complex types, and simple types, etc... 
> in the .xsd files.
>
> Some of the modules will need minor documentation fleshed out (~10%) 
> left, whereas many of the newer modules have very little documentation 
> (80%) left and/or the documentation does not at all conform to our 
> tooltip/summary/description/example/lineage convention.  Many of them 
> are merely pasted repeats through all of the doc: tags.
>
> It seems to me that the documentation will be critical for anyone not 
> within the immediate development group to digest, understand, and use 
> EML as a community standard.
>
> Since the pending beta9 release is intended to be the last beta prior 
> to a candidate release for 2.0, I feel like any modules that are not 
> completely documented should be tabled and should be included in the 
> next release when they have matured as a code base.
>
> Does anyone feel that any of the EML modules should be released 
> without  the documentation and clean code conventions that we've 
> agreed upon? It would be great to hear from anyone interested.
>
> $.02,
>
> Chris
> -- 
> _________________________________________________________________
> christopher jones     cjones at lifesci.ucsb.edu      (805) 893-5144
> marine science institute  university of california, santa barbara
> _________________________________________________________________
>
> _______________________________________________
> eml-dev mailing list
> eml-dev at ecoinformatics.org
> http://www.ecoinformatics.org/mailman/listinfo/eml-dev


-- 
---------------------------------
Dan Higgins
Software Developer
National Center for Ecological Analysis and Synthesis (NCEAS) 
735 State St. Rm 205 
Santa Barbara, CA 93101 
805-892-2531 
higgins at nceas.ucsb.edu 
---------------------------------






More information about the Eml-dev mailing list