search

bluesky / ophyd-async

Hardware abstraction for bluesky written using asyncio
https://blueskyproject.io/ophyd-async
BSD 3-Clause "New" or "Revised" License
8 stars 23 forks source link

Rename HDFDataset and HDFFile #481

Open abbiemery opened 1 month ago

abbiemery commented 1 month ago

Both HDFDataset and HDFFile have names which are not descriptive to what they actually are. It would be helpful to name these appropriately and to go through where they are used to ensure their meaning is clear and consistent.

coretl commented 1 month ago

How about HDFDocumentComposer and HDFDatasetInfo? Or some other combination of Stream, Resource, Dataset, Info, Document and HDF?

@DiamondJoseph are you good at naming things?

DiamondJoseph commented 1 month ago

no

A HDFFile produces 1 StreamResource per HDFDataset right? They all point to data stored in the same place

HDFDataset to me makes sense, or it could be HDFDatakey to map to the ObjectKey/DataKey? HDFFile -> HDFDocumentComposer makes sense to me

abbiemery commented 1 month ago

Ok, HDFDocumentComposer and HDFDatakey it is