search

audeering / audbcards

Data cards for audio datasets
https://audeering.github.io/audbcards/
Other
0 stars 0 forks source link

DOC: Dataset attributes and methods #69

Closed hagenw closed 6 months ago

hagenw commented 6 months ago

Closes #66

This ensures that all attributes/methods of audbcards._Dataset are also included in audbcards.Dataset and are displayed in its API documentation.

At the moment this is done by assigning them all manually inside audbcards.Dataset, but I haven't found a better way yet.

image

ChristianGeng commented 6 months ago

I have implemented setting the cached properties programmatically in 2bf18fd3d1dccc82d00eb85efc6ae8c13c8b3812. This can be done via vars. My understanding is that this will not leak to the global namespace. I have not tested it however. Running existing tests does not yield any regressions.

There is one difference: properties has been a method of the _Dataset class. It currently is not documented in the API docs. Possibly one would implement by using the code that you had before.

Now things have crossed: I have boldly committed without having the review request on the radar.

hagenw commented 6 months ago

Now things have crossed: I have boldly committed without having the review request on the radar.

Doesn't matter, I just assigned you so you get an alert that something is going on here. Would be very nice, if we could solve it programmatically.

My understanding is that this will not leak to the global namespace. I have not tested it however.

Could you try to test this?

ChristianGeng commented 6 months ago

Could you try to test this?

Yes, in dbc7cae

hagenw commented 6 months ago

Great, I think we are ready to merge here, or any objections?

ChristianGeng commented 6 months ago

Great, I think we are ready to merge here, or any objections?

I have written an approval review. Shall I merge or do you want to go for it?