Skip to content

Comments

docs: Document the public API#4

Closed
velocitysystems wants to merge 1 commit intosilvermine:masterfrom
velocitysystems:readme
Closed

docs: Document the public API#4
velocitysystems wants to merge 1 commit intosilvermine:masterfrom
velocitysystems:readme

Conversation

@velocitysystems
Copy link
Contributor

@velocitysystems velocitysystems commented Aug 19, 2025

This PR adds comprehensive documentation for the media-parser crate, detailing its capabilities and public API.
Key features:

  • Retrieving metadata (title, artist, album, duration, etc.)
  • Listing tracks with type, codec, and language
  • Extracting subtitles by track ID or language
  • Capturing single or multiple video thumbnails

@velocitysystems velocitysystems changed the title docs: Update README.md to document public API docs: Document the public API Aug 19, 2025
@velocitysystems
Copy link
Contributor Author

Reviewed with @polw1 and updated to include an additional API for retrieving metadata.

@velocitysystems
Copy link
Contributor Author

@yokuze @onebytegone Added package.json and standardization.

@velocitysystems velocitysystems force-pushed the readme branch 4 times, most recently from d599b1d to 92281ab Compare August 25, 2025 13:57
Copy link
Contributor

@yokuze yokuze left a comment

Choose a reason for hiding this comment

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

Thanks for all of the updates and for starting out with docs.

I think this is far as I can get in the review before some of the comments are addressed, esp. the one about moving some of the code into Rust files.

Also, please keep in mind that my review is limited to:

  • Does this follow our coding standards?
  • Does this make sense an API?
  • Are there logical errors, missing info, etc.?

but since I do not have any information about our use cases for the library I cannot review at the level of:

  • Does this API provide all the functionality we need? Should it do more / less / something different?
  • Should we be doing this at all, or something else given our goals? (Probably it's fine, but again, I don't have enough context)

For that, we'll need a discussion with @jthomerson and others, and perhaps soon we can sync up and you can give me an overview of what use cases you know of.

@yokuze
Copy link
Contributor

yokuze commented Aug 26, 2025

Some of my earlier comments may not be relevant after you added MD linting.

@velocitysystems velocitysystems force-pushed the readme branch 3 times, most recently from de273fe to 774873d Compare August 30, 2025 16:30
@velocitysystems
Copy link
Contributor Author

Closing in favour of #7.

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.

3 participants