On Tue, Oct 4, 2011 at 8:27 AM, Robert Muir <[email protected]> wrote: > On Tue, Oct 4, 2011 at 6:44 AM, Michael McCandless > <[email protected]> wrote: >> Can we stop trying to document the file format? >> >> Is it really needed? It has been an error-proned process over time... >> >> Can't the source code be the definitive resource one reads to >> determine how a codec stores stuff....? > > I think it should be optional, not mandatory. > > If someone wants to write up and maintain file format descriptions, > thats a great contribution to the project. > Otherwise, it doesn't happen.
+1 > I also think that it shouldnt be forrested on some versioned website > (which means you "automatically" get a copy of the previous version, > just asking for outdated docs). It would be better to have this as a > single-document on the wiki: better to be incomplete and not have all > versions than to be wrong. Can we also simply link into the sources for that version....? Like if the jdocs for the default codec spell out the format in some detail we can just link to that? Similarly I the awesome jdocs in our default Sim impl are under-exposed.... Mike --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
