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

Documentation bug: format::context::common::Context is not publically exported #206

Open
ultrabear opened this issue Aug 26, 2024 · 0 comments

Comments

@ultrabear
Copy link

ultrabear commented Aug 26, 2024

The return type of ffmpeg_next::format::input() is an Result<Input, Error>,
The type Input Deref's to a format::context::common::Context (located in src/format/context/common.rs#18), this provides various methods to work with an input (of which I am relying on Context::metadata to read ID3 tags), and given that some example code uses it I assume that it is meant to be publicly exported somewhere?

Not being publicly exported means that docs.rs will not show documentation on that type, despite being able to use the type in normal code.

ideal resolution: publicly exporting the Context type anywhere such that documentation can show the methods it exposes

@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
@github-staff github-staff deleted a comment from Lxx-c Oct 23, 2024
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

No branches or pull requests

4 participants
@ultrabear and others