AlexsLemonade / scpca-docs

User information about ScPCA processing
https://scpca.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Update docs for upcoming h5ad transition #287

Closed jashapiro closed 6 months ago

jashapiro commented 6 months ago

I think I got all the places in the docs that we talked about hdf5 files.

We will still need to update the following files in the images directory

closes #288

jashapiro commented 6 months ago

Added the images from https://github.com/AlexsLemonade/scpca-docs/issues/288#issuecomment-2050381631

jashapiro commented 6 months ago

@allyhawkins @dvenprasad I left references to "HDF5 files" in the text, but since the extension is now .h5ad everywhere, I worry that might be confusing. Should I change those to "H5AD files"?

allyhawkins commented 6 months ago

@allyhawkins @dvenprasad I left references to "HDF5 files" in the text, but since the extension is now .h5ad everywhere, I worry that might be confusing. Should I change those to "H5AD files"?

I had seen this and was wondering the same thing, but assumed you had made the choice to keep them as HDF5. I think using H5AD everywhere would be less confusing though.

allyhawkins commented 6 months ago

We should wait to merge this until we have released the docs for merged objects. We will incorporate the new extension after merged objects are up.

jashapiro commented 6 months ago

@allyhawkins I requested rereview mostly just to confirm that we are ready to merge this.