pion / webrtc

Pure Go implementation of the WebRTC API
https://pion.ly
MIT License
13.9k stars 1.66k forks source link

Improve the documentation of NewPeerConnection #2949

Open jech opened 3 weeks ago

jech commented 3 weeks ago

Please do not commit until @Sean-Der has had a chance to comment on 2943.

Fixes #2943

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.63%. Comparing base (363e017) to head (3ee0ee6). Report is 3 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2949 +/- ## ========================================== - Coverage 77.74% 77.63% -0.12% ========================================== Files 89 89 Lines 10462 10462 ========================================== - Hits 8134 8122 -12 - Misses 1840 1850 +10 - Partials 488 490 +2 ``` | [Flag](https://app.codecov.io/gh/pion/webrtc/pull/2949/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pion) | Coverage Δ | | |---|---|---| | [go](https://app.codecov.io/gh/pion/webrtc/pull/2949/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pion) | `79.19% <ø> (-0.13%)` | :arrow_down: | | [wasm](https://app.codecov.io/gh/pion/webrtc/pull/2949/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pion) | `63.56% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=pion#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features: