TheELNConsortium / TheELNFileFormat

Specification for the ELN File Format
MIT License
41 stars 7 forks source link

Update SampleDB example #30

Closed FlorianRhiem closed 9 months ago

FlorianRhiem commented 9 months ago

@nicobrandt is the import issue solved with this updated example?

nicobrandt commented 9 months ago

Thanks for the ping! I just tested it really quick and was able to import the basic metadata and files successfully again :+1: Note that, as we discussed yesterday, I don't think your previous example was "broken", it is just how our current import code works based on the other examples. However, we should probably not abort the import just because this entry might be missing or it was put somewhere else (maybe we can just issue a warning instead, if at all).

Sorry for potentially derailing the discussion a bit, but another thing I noticed is that the descriptions could not be imported, because our code expects them to be in the "text" property (while reserving "description" for "meta" comments, such as labelling exported metadata files). This is again something that we simply did based on our own export and the other examples, so either this is something that we could "standardize" eventually or the import code just attempts to use both. From the discussion yesterday, I guess the latter option might be preferred for now? ;) @NicolasCARPi

FlorianRhiem commented 9 months ago

The description properties such as "Object #1 version #0" are generated during the export and aren't really important, so I don't think anything of value is lost if they can't be imported.

nicobrandt commented 9 months ago

Ah I see, thanks a lot for clarifying! Then I guess your use of description fits well with the other examples after all. Still good to think about potential cases like these though.