search

mapping-commons / sssom-py

Python toolkit for SSSOM mapping format
https://mapping-commons.github.io/sssom-py/index.html#
MIT License
49 stars 12 forks source link

Docs: Are built-in prefixes in metadata required, or recommended? #535

Closed joeflack4 closed 4 months ago

joeflack4 commented 4 months ago

Overview

Just a request to have documentation on this.

Context

This is coming from #513, where I was creating a MappingSetDataFrame with no pre-initialized Converter. The metadata created included some built-in prefixes which do not appear anywhere in my mapping set.

Thoughts

I prefer to be minimalist to the point that I want prefixes in my metadata if and only if they appear in mapping set / any of the rows in my TSV. But I do see the UX benefits of including common built-ins.

matentzn commented 4 months ago

Sorry I accidentally moved the issue here as it was talking about implementation details, but the issue title is indeed about the model, and not the toolkit. Can you create new issue in sssom linking to this one here w/o mentioning implementation details? Just ask for a clarification in the docs on whether built-in prefixes are optional or not in the metadata. Sorry about that - my mistake.

joeflack4 commented 4 months ago

Done!

joeflack4 commented 4 months ago

https://github.com/mapping-commons/sssom/issues/365 is closed now, and I don't see a reason for this one to still be open; closing.