Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: mention explicitly text files as media files #441

Merged
merged 2 commits into from
Jun 24, 2024
Merged

DOC: mention explicitly text files as media files #441

merged 2 commits into from
Jun 24, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Jun 24, 2024

Closes #439

Rephrases the README and data format specifications to better indicate that media files are not restricted in its file type.

In addition, it explicitly names text files as potential media files. I also state that a segmented table can be used, if applicable, as some file types might not have a direct connection to a timeline. E.g. you can create a segmented table for text files, but it might be meaningless as no other application might be able to use that information.

README

image

Format specifications -- Introduction

image

Format specification -- Database

image

@hagenw hagenw requested a review from ChristianGeng June 24, 2024 08:59
Copy link
Member

@ChristianGeng ChristianGeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This updates the documentation to reflect that it generalizes "audio" data to more general "media" data.

The only concern that I have is whether even "media" is general enough, or whether even a more general term like "sensor data" should be used, as future releases might need to expand to other sensing modalities with fixed sampling rate - or even rare events that are not sampled.

Still, the description is valid for now and therefore approval will be given.

@hagenw
Copy link
Member Author

hagenw commented Jun 24, 2024

Thanks for pointing out the concern regarding "Media file". I created #444 to track that, as I also think this would require more rewriting of the documentation, and should be handled independent of this pull request.

@hagenw hagenw merged commit f10c2ed into main Jun 24, 2024
10 checks passed
@hagenw hagenw deleted the doc-text branch June 24, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document that media files don't have to be audio or video files
2 participants