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

misc(docs): rectify typos and spelling mistakes #1632

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion inputfiles/idl/websockets.commentmap.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"closeevent-reason": "Returns the WebSocket connection close reason provided by the server.",
"websocket": "Creates a new WebSocket object, immediately establishing the associated WebSocket connection.\n\nurl is a string giving the URL over which the connection is established. Only \"ws\" or \"wss\" schemes are allowed; others will cause a \"SyntaxError\" DOMException. URLs with fragments will also cause such an exception.\n\nprotocols is either a string or an array of strings. If it is a string, it is equivalent to an array consisting of just that string; if it is omitted, it is equivalent to the empty array. Each string in the array is a subprotocol name. The connection will only be established if the server reports that it has selected one of these subprotocols. The subprotocol names have to match the requirements for elements that comprise the value of Sec-WebSocket-Protocol fields as defined by The WebSocket protocol. [WSP]",
"websocket-send": "Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.",
"websocket-close": "Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.",
"websocket-close": "Closes the WebSocket connection, optionally using code as the WebSocket connection close code and reason as the WebSocket connection close reason.",
"websocket-url": "Returns the URL that was used to establish the WebSocket connection.",
"websocket-readystate": "Returns the state of the WebSocket object's connection. It can have the values described below.",
"websocket-bufferedamount": "Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.\n\nIf the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)",
Expand Down
22 changes: 11 additions & 11 deletions inputfiles/mdn/apiDescriptions.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"BeforeUnloadEvent": "The beforeunload event is fired when the window, the document and its resources are about to be unloaded.",
"BiquadFilterNode": "The BiquadFilterNode interface represents a simple low-order filter, and is created using the AudioContext.createBiquadFilter() method. It is an AudioNode that can represent different kinds of filters, tone control devices, and graphic equalizers.",
"Blob": "A Blob object represents a file-like object of immutable, raw data. Blobs represent data that isn't necessarily in a JavaScript-native format. The File interface is based on Blob, inheriting blob functionality and expanding it to support files on the user's system.",
"ByteLengthQueuingStrategy": "The ByteLengthQueuingStrategy interface of the the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.",
"ByteLengthQueuingStrategy": "The ByteLengthQueuingStrategy interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.",
"CDATASection": "The CDATASection interface represents a CDATA section that can be used within XML to include extended portions of unescaped text. The symbols < and & don’t need escaping as they normally do when inside a CDATA section.",
"CSS": "The CSS interface holds useful CSS-related methods. No object with this interface are implemented: it contains only static methods and therefore is a utilitarian interface.",
"CSSConditionRule": "An object implementing the CSSConditionRule interface represents a single condition CSS at-rule, which consists of a condition and a statement block. It is a child of CSSGroupingRule.",
Expand Down Expand Up @@ -51,7 +51,7 @@
"Console": "The Console object provides access to the browser's debugging console (e.g. the Web Console in Firefox). The specifics of how it works varies from browser to browser, but there is a de facto set of features that are typically provided.",
"ConvolverNode": "The ConvolverNode interface is an AudioNode that performs a Linear Convolution on a given AudioBuffer, often used to achieve a reverb effect. A ConvolverNode always has exactly one input and one output.",
"Coordinates": "The Coordinates interface represents the position and altitude of the device on Earth, as well as the accuracy with which these properties are calculated.",
"CountQueuingStrategy": "The CountQueuingStrategy interface of the the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.",
"CountQueuingStrategy": "The CountQueuingStrategy interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.",
"Crypto": "The Crypto interface represents basic cryptography features available in the current context. It allows access to a cryptographically strong random number generator and to cryptographic primitives.",
"CryptoKey": "The CryptoKey dictionary of the Web Crypto API represents a cryptographic key.",
"CryptoKeyPair": "The CryptoKeyPair dictionary of the Web Crypto API represents a key pair for an asymmetric cryptography algorithm, also known as a public-key algorithm.",
Expand All @@ -68,7 +68,7 @@
"DedicatedWorkerGlobalScope": "The DedicatedWorkerGlobalScope object (the Worker global scope) is accessible through the self keyword. Some additional global functions, namespaces objects, and constructors, not typically associated with the worker global scope, but available on it, are listed in the JavaScript Reference. See also: Functions available to workers.",
"DelayNode": "The DelayNode interface represents a delay-line; an AudioNode audio-processing module that causes a delay between the arrival of an input data and its propagation to the output.",
"DeviceAcceleration": "A DeviceAcceleration object provides information about the amount of acceleration the device is experiencing along all three axes.",
"DeviceLightEvent": "The DeviceLightEvent provides web developers with information from photo sensors or similiar detectors about ambient light levels near the device. For example this may be useful to adjust the screen's brightness based on the current ambient light level in order to save energy or provide better readability.",
"DeviceLightEvent": "The DeviceLightEvent provides web developers with information from photo sensors or similar detectors about ambient light levels near the device. For example this may be useful to adjust the screen's brightness based on the current ambient light level in order to save energy or provide better readability.",
Copy link
Contributor

Choose a reason for hiding this comment

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

I guess this one can be fully removed, MDN doesn't have it anymore and lib.d.ts doesn't have it either.

Copy link
Author

Choose a reason for hiding this comment

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

Okay

"DeviceMotionEvent": "The DeviceMotionEvent provides web developers with information about the speed of changes for the device's position and orientation.",
"DeviceOrientationEvent": "The DeviceOrientationEvent provides web developers with information from the physical orientation of the device running the web page.",
"DeviceRotationRate": "A DeviceRotationRate object provides information about the rate at which the device is rotating around all three axes.",
Expand Down Expand Up @@ -237,7 +237,7 @@
"Path2D": "The Path2D interface of the Canvas 2D API is used to declare a path that can then be used on a CanvasRenderingContext2D object. The path methods of the CanvasRenderingContext2D interface are also present on this interface, which gives you the convenience of being able to retain and replay your path whenever desired.",
"PaymentAddress": "The PaymentAddress interface of the Payment Request API is used to store shipping or payment address information.",
"PaymentRequest": "The PaymentRequest interface of the Payment Request API is the primary access point into the API, and lets web content and apps accept payments from the end user.",
"PaymentRequestUpdateEvent": "The PaymentRequestUpdateEvent interface of the the Payment Request API enables a web page to update the details of a PaymentRequest in response to a user action.",
"PaymentRequestUpdateEvent": "The PaymentRequestUpdateEvent interface of the Payment Request API enables a web page to update the details of a PaymentRequest in response to a user action.",
"PaymentResponse": "The PaymentResponse interface of the Payment Request API is returned after a user selects a payment method and approves a payment request.",
"Performance": "The Performance interface provides access to performance-related information for the current page. It's part of the High Resolution Time API, but is enhanced by the Performance Timeline API, the Navigation Timing API, the User Timing API, and the Resource Timing API.",
"PerformanceEntry": "The PerformanceEntry object encapsulates a single performance metric that is part of the performance timeline. A performance entry can be directly created by making a performance mark or measure (for example by calling the mark() method) at an explicit point in an application. Performance entries are also created in indirect ways such as loading a resource (such as an image).",
Expand All @@ -259,13 +259,13 @@
"PushEvent": "The PushEvent interface of the Push API represents a push message that has been received. This event is sent to the global scope of a ServiceWorker. It contains the information sent from an application server to a PushSubscription.",
"PushManager": "The PushManager interface of the Push API provides a way to receive notifications from third-party servers as well as request URLs for push notifications.",
"PushMessageData": "The PushMessageData interface of the Push API provides methods which let you retrieve the push data sent by a server in various formats.",
"PushSubscription": "The PushSubscription interface of the Push API provides a subcription's URL endpoint and allows unsubscription from a push service.",
"PushSubscription": "The PushSubscription interface of the Push API provides a subscription'sURL endpoint and allows unsubscription from a push service.",
"RTCDTMFToneChangeEvent": "The RTCDTMFToneChangeEvent interface represents events sent to indicate that DTMF tones have started or finished playing. This interface is used by the tonechange event.",
"RTCIceCandidate": "The RTCIceCandidate interface—part of the WebRTC API—represents a candidate Internet Connectivity Establishment (ICE) configuration which may be used to establish an RTCPeerConnection.",
"RTCIceTransport": "The RTCIceTransport interface provides access to information about the ICE transport layer over which the data is being sent and received.",
"RTCPeerConnection": "The RTCPeerConnection interface represents a WebRTC connection between the local computer and a remote peer. It provides methods to connect to a remote peer, maintain and monitor the connection, and close the connection once it's no longer needed.",
"RTCPeerConnectionIceEvent": "The RTCPeerConnectionIceEvent interface represents events that occurs in relation to ICE candidates with the target, usually an RTCPeerConnection. Only one event is of this type: icecandidate.",
"RTCRtpReceiver": "The RTCRtpReceiver interface of the the WebRTC API manages the reception and decoding of data for a MediaStreamTrack on an RTCPeerConnection.",
"RTCRtpReceiver": "The RTCRtpReceiver interface of the WebRTC API manages the reception and decoding of data for a MediaStreamTrack on an RTCPeerConnection.",
"RTCRtpSender": "The RTCRtpSender interface provides the ability to control and obtain details about how a particular MediaStreamTrack is encoded and sent to a remote peer.",
"RTCSessionDescription": "The RTCSessionDescription interface describes one end of a connection—or potential connection—and how it's configured. Each RTCSessionDescription consists of a description type indicating which part of the offer/answer negotiation process it describes and of the SDP descriptor of the session.",
"Range": "The Range interface represents a fragment of a document that can contain nodes and parts of text nodes.",
Expand Down Expand Up @@ -381,7 +381,7 @@
"StyleSheetList": "The StyleSheetList interface represents a list of StyleSheet.",
"SubtleCrypto": "The SubtleCrypto interface of the Web Crypto API provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto).",
"SyncEvent": "The SyncEvent interface represents a sync action that is dispatched on the ServiceWorkerGlobalScope of a ServiceWorker. ",
"SyncManager": "The SyncManager interface of the the ServiceWorker API provides an interface for registering and listing sync registrations.",
"SyncManager": "The SyncManager interface of the ServiceWorker API provides an interface for registering and listing sync registrations.",
"Text": "The Text interface represents the textual content of Element or Attr. If an element has no markup within its content, it has a single child implementing Text that contains the element's text. However, if the element contains markup, it is parsed into information items and Text nodes that form its children.",
"TextDecoder": "The TextDecoder interface represents a decoder for a specific method, that is a specific character encoding, like utf-8, iso-8859-2, koi8, cp1261, gbk, etc. A decoder takes a stream of bytes as input and emits a stream of code points. For a more scalable, non-native library, see StringView – a C-like representation of strings based on typed arrays.",
"TextEncoder": "TextEncoder takes a stream of code points as input and emits a stream of bytes. For a more scalable, non-native library, see StringView – a C-like representation of strings based on typed arrays.",
Expand All @@ -399,7 +399,7 @@
"URL": "The URL interface represents an object providing static methods used for creating object URLs.",
"VRDisplay": "The VRDisplay interface of the WebVR API represents any VR device supported by this API. It includes generic information such as device IDs and descriptions, as well as methods for starting to present a VR scene, retrieving eye parameters and display capabilities, and other important functionality.",
"VRDisplayCapabilities": "The VRDisplayCapabilities interface of the WebVR API describes the capabilities of a VRDisplay — its features can be used to perform VR device capability tests, for example can it return position information.",
"VRDisplayEvent": "The VRDisplayEvent interface of the WebVR API represents represents the event object of WebVR-related events (see the list of WebVR window extensions).",
"VRDisplayEvent": "The VRDisplayEvent interface of the WebVR API represents the event object of WebVR-related events (see the list of WebVR window extensions).",
"VREyeParameters": "The VREyeParameters interface of the WebVR API represents all the information required to correctly render a scene for a given eye, including field of view information.",
"VRFieldOfView": "The VRFieldOfView interface of the WebVR API represents a field of view defined by 4 different degree values describing the view from a center point.",
"VRFrameData": "The VRFrameData interface of the WebVR API represents all the information needed to render a single frame of a VR scene; constructed by VRDisplay.getFrameData().",
Expand Down Expand Up @@ -431,9 +431,9 @@
"WorkerGlobalScope": "The WorkerGlobalScope interface of the Web Workers API is an interface representing the scope of any worker. Workers have no browsing context; this scope contains the information usually conveyed by Window objects — in this case event handlers, the console or the associated WorkerNavigator object. Each WorkerGlobalScope has its own event loop.",
"WorkerLocation": "The WorkerLocation interface defines the absolute location of the script executed by the Worker. Such an object is initialized for each worker and is available via the WorkerGlobalScope.location property obtained by calling self.location.",
"WorkerNavigator": "The WorkerNavigator interface represents a subset of the Navigator interface allowed to be accessed from a Worker. Such an object is initialized for each worker and is available via the WorkerGlobalScope.navigator property obtained by calling window.self.navigator.",
"WritableStream": "The WritableStream interface of the the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.",
"WritableStreamDefaultController": "The WritableStreamDefaultController interface of the the Streams API represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.",
"WritableStreamDefaultWriter": "The WritableStreamDefaultWriter interface of the the Streams API is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.",
"WritableStream": "The WritableStream interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.",
"WritableStreamDefaultController": "The WritableStreamDefaultController interface of the Streams API represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.",
"WritableStreamDefaultWriter": "The WritableStreamDefaultWriter interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the < writer to the WritableStream ensuring that no other streams can write to the underlying sink.",
"XMLDocument": "The XMLDocument interface represents an XML document. It inherits from the generic Document and does not add any specific methods or properties to it: nevertheless, several algorithms behave differently with the two types of documents.",
"XMLHttpRequest": "Use XMLHttpRequest (XHR) objects to interact with servers. You can retrieve data from a URL without having to do a full page refresh. This enables a Web page to update just part of a page without disrupting what the user is doing.",
"XMLSerializer": "The XMLSerializer interface provides the serializeToString() method to construct an XML string representing a DOM tree.",
Expand Down
Loading