Skip to content

Add "required" annotation to params #11

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

Merged
merged 2 commits into from
Mar 24, 2025
Merged

Conversation

brzep
Copy link
Contributor

@brzep brzep commented Mar 7, 2025

added "[required]" annotation to Publisher.attach/2 and Player.attach/2 options

@brzep brzep requested a review from mickel8 March 7, 2025 10:24
* `publisher_id` - publisher id that this player is going to subscribe to.
* `on_connected` - callback called when the underlying peer connection changes its state to the `:connected`. See `t:on_connected/0`.
* `publisher_id` [**required**] - publisher id that this player is going to subscribe to.
* `on_connected` [**required**] - callback called when the underlying peer connection changes its state to the `:connected`. See `t:on_connected/0`.
Copy link
Member

@sgfn sgfn Mar 7, 2025

Choose a reason for hiding this comment

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

  1. on_connected isn't required
  2. I just noticed we're missing the required pubsub option in the list XDD

@brzep brzep merged commit 3df7475 into master Mar 24, 2025
@brzep brzep deleted the brzep/docs-add-required branch May 13, 2025 09:36
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.

2 participants