search

samvera / valkyrie

A Data Mapper library to enable multiple backends for storage of files and metadata in Samvera
Other
34 stars 23 forks source link

Valkyrie::StorageAdapter documentation correction? #951

Closed dchandekstark closed 7 months ago

dchandekstark commented 7 months ago

The documentation on Valkyrie::StorageAdapter -- at https://github.com/samvera/valkyrie/blob/ccb2677d100d26871c31b934365abba4881e60a6/lib/valkyrie/storage_adapter.rb#L28 and https://github.com/samvera/valkyrie/blob/ccb2677d100d26871c31b934365abba4881e60a6/lib/valkyrie/storage_adapter.rb#L56 -- suggests that adapters are instances of that class, although they are not. (I'm not sure why adapters shouldn't subclass V::SA, but apparently things went a different way?) Is a documentation correction warranted?

tpendragon commented 7 months ago

suggests that adapters are instances of that class, although they are not. (I'm not sure why adapters shouldn't subclass V::SA, but apparently things went a different way?) Is a documentation correction warranted?

Seems reasonable!