content icon indicating copy to clipboard operation
content copied to clipboard

Confusing wording around return value of RTCPeerConnection.createOffer

Open srujzs opened this issue 9 months ago • 0 comments

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 avatar May 06 '24 23:05 srujzs