Revision: 1287 Author: sebastien.lelong Date: Thu Sep 3 12:34:26 2009 Log: few words about how to store 3rd party / external data http://code.google.com/p/jallib/source/detail?r=1287
Modified: /wiki/JallibStyleGuide.wiki ======================================= --- /wiki/JallibStyleGuide.wiki Mon Aug 17 09:22:50 2009 +++ /wiki/JallibStyleGuide.wiki Thu Sep 3 12:34:26 2009 @@ -349,3 +349,12 @@ It helps readers understand what's going on. The comment should describe *why* your code does its thing, not what is does. That should be obvious from the code itself. + + += External data = + +When developing a library, you may need to collect and organize external / 3rd party data. For instance, the relation between a datasheet reference and the PICs described in this datasheet is what we call external data: it's not jal code, but _often_ used to generate some, and _always_ a source of information everyone can refer too. + +External data must store in a *structured format* so everyone potentially is able to use it. Before we, developers, are also (kind of) humans, we want this format to be readable, and even writable, but also structured enough so a computer can also use and exploit it. That's why this format is [http://www.json.org/ JSON] (and not XML), which is available in many languages. This is a way to share information, amongst the many scripts used to deal jal code base. + + --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "jallib" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/jallib?hl=en -~----------~----~----~----~------~----~------~--~---
