search

HumanBrainProject / openMINDS

openMINDS comprises a set of metadata models for research products in the field of neuroscience.
MIT License
40 stars 13 forks source link

updated descriptions in properties #13

Closed lzehl closed 3 years ago

lzehl commented 3 years ago

updating descriptions for all properties

lzehl commented 3 years ago

@apdavison there is more to come and I would appreciate your feedback on all descriptions. I find it quite tough to write them to be honest. Would you continue the review?

lzehl commented 3 years ago

@apdavison thanks for providing such a quick review on this. I've updated most of what you noticed (and hopefully did not introduce more typos ;)), except for the description of "hasAlternativeVersion", and "hasParent". Do you have ideas for those?

lzehl commented 3 years ago

@apdavison except for the description for "hasParents" I've updated now all. Could you review the changes and see if they are correct? Thanks a lot in advance!

UlrikeS91 commented 3 years ago

@lzehl: All property name changes in the schemas are done through PRs now (still need to be reviewed and merged). I forgot to note done anywhere that we want to update the names of the properties to reflect that potential plural, e.g.

    "author": {
        [...]
        "name": "Author",
        [...]  
    },

to

    "author": {
        [...]
        "name": "Author(s)",
        [...]  
    },

I didn't want to start this myself before 1) the properties.json is updated with the property changes from the different PRs and 2) your PR here is merged/closed.

lzehl commented 3 years ago

@apdavison : I've updated the properties according to the latest changes in the openMINDS submodules. All deprecated properties should be removed (hope I did not overlook one) and all existing properties should have a description now. Could you review it again?

@UlrikeS91 : thanks for the reminder, but when I went over it now, I realized that we can't do this. The name is applied to all schemas that use this property, but not all schemas do expect the same number of values for that property. So we have to keep this information (how many values are you allowed to enter) in the instructions.

apdavison commented 3 years ago

@lzehl I'm a bit over-committed this week and next, so please don't wait for my review.

lzehl commented 3 years ago

@apdavison okay, I can ask @UlrikeS91 to have a final check and to merge it.