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

Confusing wording around return value of RTCPeerConnection.createOffer #33453

Open
srujzs opened this issue May 6, 2024 · 0 comments
Open

Confusing wording around return value of RTCPeerConnection.createOffer #33453

srujzs opened this issue May 6, 2024 · 0 comments
Labels
Content:WebAPI Web API docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@srujzs
Copy link

srujzs commented May 6, 2024

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createOffer

What specific section or headline is this issue about?

Return value

What information was incorrect, unhelpful, or incomplete?

In the main section, the return value is described as:

The return value is a Promise which, when the offer has been created, is resolved with a RTCSessionDescription object containing the newly-created offer.

But then in the "Return value" section, it states:

A Promise whose fulfillment handler will receive an object conforming to the RTCSessionDescriptionInit dictionary which contains the SDP describing the generated offer. That received offer should be delivered through the signaling server to a remote peer.

which seems incompatible, or at the very least, confusing.

What did you expect to see?

The sections describing the return value should be the same.

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

@srujzs srujzs added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label May 6, 2024
@github-actions github-actions bot added Content:JS JavaScript docs Content:WebAPI Web API docs labels May 6, 2024
@Josh-Cena Josh-Cena removed the Content:JS JavaScript docs label May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

2 participants