laminlabs / lamindb

A data framework for biology.
https://docs.lamin.ai
Apache License 2.0
129 stars 12 forks source link

📝 Prettify gene symbols guide & logging #2210

Closed falexwolf closed 1 day ago

falexwolf commented 1 day ago

Before:

! Curating gene symbols is discouraged. See FAQ for more details.

After:

! indexing datasets with gene symbols can be problematic: https://docs.lamin.ai/faq/symbol-mapping

I have a case where I consciously want to use gene symbols for the sake of illustrating something; not for the sake of curating a large body of data.

Hearing some feedback from some users this seems to be very common. So, I'd not make the warning as harsh.

I was missing the URL so that I could read up on this.

Made the warning lowercase consistent with all other logging messages (including warnings).

Replace hanging indentation with vertically aligned indendation.

See:

codecov[bot] commented 1 day ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.36%. Comparing base (c54f99f) to head (e459790). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2210 +/- ## ======================================= Coverage 92.36% 92.36% ======================================= Files 54 54 Lines 6566 6566 ======================================= Hits 6065 6065 Misses 501 501 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features:

github-actions[bot] commented 1 day ago

🚀 Deployed on https://67441d0ef2fea4ced22fba01--lamindb-qnwk.netlify.app

Zethson commented 1 day ago

Thank you!