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 is lacking #1010

Open
BassMastaCod opened this issue Jan 23, 2025 · 0 comments
Open

Documentation is lacking #1010

BassMastaCod opened this issue Jan 23, 2025 · 0 comments

Comments

@BassMastaCod
Copy link

I used this library years ago, but I'm struggling to return to it now. I've tried working from scratch as well but the root of my problem is that I don't understand some of the design.

Here are a few quick examples:

  1. The whole zeroconf integration seems new. I haven't (knowingly) used that in the past and I'm still unsure if I have to. Some examples within the README include it while some don't. In addition, zeroconf looks to be a resource that needs to be closed when finished with it?
  2. I also haven't needed to use the browser but there isn't any info on how to without trying to dig into the code. The README shows a SimpleCastListener but it is not much to go off of.
  3. I'm unsure when the stop discovery needs to occur, the README shows it after playing media but I'm not convinced that is related. The README also shows discovery being started once but stopped twice so maybe I'm missing something.

Overall, with the formatting, it is difficult to tell where one example stops and another starts.

I would love to use this library again but it has been a guessing game for me so far. Can we please give the documentation some love? I am not looking for anything super involved. The scope of the existing examples may be sufficient if they were a little more fleshed out.

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

1 participant