search

single-cell-data / SOMA

A flexible and extensible API for annotated 2D matrix data stored in multiple underlying formats.
MIT License
71 stars 9 forks source link

Minor edits: sc_group -> soma, whitespace, punctuation, etc. #28

Closed johnkerl closed 2 years ago

johnkerl commented 2 years ago

Mods are more syntactic than semantic.

I found that bring name-changes up to date reduces cognitive friction a bit in my reading, as we start to prototype the Python API.

Reviewer-friendly link: https://github.com/single-cell-data/matrix-api/blob/kerl/minor-edits/specification.md

bkmartinjr commented 2 years ago

CC @brianraymor

aaronwolen commented 2 years ago

Also noting this would close #27.

johnkerl commented 2 years ago

@brianraymor these are fabulous deep edits!

If it's OK with you, I'd like to merge the shallower mods (e.g. SCGroup -> SOMA, and whitespace) sooner on this PR, then address the (very worthwhile) style/organizational/structural editts on a second PR -- would this work for you?

brianraymor commented 2 years ago

@johnkerl - I'll focus my review on the shallower mods so we can merge sooner. I was reaching the same conclusion.

I plan to completely remodel and edit the specification, so no requirement for a second PR from you on that front. Not the best use of valuable Dev time from my perspective.

johnkerl commented 2 years ago

@brianraymor "shallow edits" complete for your review ...

brianraymor commented 2 years ago

What about - https://github.com/single-cell-data/matrix-api/pull/28/files#r883969626 ? (At least until we delete the code samples per my other suggestion).

johnkerl commented 2 years ago

@brianraymor very sorry! :(

I missed a spot on https://github.com/single-cell-data/matrix-api/pull/28/commits/6046a8ba73339637d79e3833f2760232029b1211 -- please also see https://github.com/single-cell-data/matrix-api/pull/28/commits/e2537a48c817e93e0755c3246ddb65c71b0ee83f

johnkerl commented 2 years ago

@brianraymor @bkmartinjr can we perhaps merge this to get name changes like sc_group -> SOMA in place?

brianraymor commented 2 years ago

@johnkerl - my understanding is that @ambrosejcarr planned to remove the specification. I will follow up with him.

ambrosejcarr commented 2 years ago

It makes sense to commit these improvements to the version history.

The specification will be removed in #31.