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

Document the "empty defaults" behaviour of NewAPI fn #2517

Closed
wants to merge 1 commit into from

Conversation

ForestJohnson
Copy link
Contributor

Description

I think webrtc.NewAPI docstring needs needs an ALL CAPS BOLD WARNING TEXT and a link to an example of how to set it up to so that the resulting webrtc.NewPeerConnection()s will behave exactly the same as the ones you get from the default webrtc.NewPeerConnection().

Reference issue

Fixes #2516

@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.09 🎉

Comparison is base (90e3a83) 77.61% compared to head (55051d4) 77.70%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2517      +/-   ##
==========================================
+ Coverage   77.61%   77.70%   +0.09%     
==========================================
  Files          87       87              
  Lines        9357     9357              
==========================================
+ Hits         7262     7271       +9     
+ Misses       1663     1657       -6     
+ Partials      432      429       -3     
Flag Coverage Δ
go 79.47% <ø> (+0.10%) ⬆️
wasm 70.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
api.go 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Sean-Der
Copy link
Member

Sorry this took so long @ForestJohnson I really appreciate your feedback. I am ignorant to how it feels as a new user to use Pion. Your feedback/notes are really important. Anything else that frustrated you?

Merged with 6b22634

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.

webrtc.NewAPI is inherently confusing and frustrating
3 participants