Skip to content

Commit

Permalink
Capitalize first sentence of admonitions (#35163)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-Cena authored Jul 26, 2024
1 parent c5f403b commit 4dec42e
Show file tree
Hide file tree
Showing 58 changed files with 62 additions and 64 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Now, when we have our mobile controls in place and the game is playable on touch
It's also easier to test control-independent features like gameplay on desktop if you develop it there, so you don't have to push the files to a mobile device every time you make a change in the source code.

> [!NOTE]
> the [Captain Rogers: Battle at Andromeda](https://rogers2.enclavegames.com/demo/) is built with Phaser and managing the controls is Phaser-based, but it could also be done in pure JavaScript. The good thing about using Phaser is that it offers helper variables and functions for easier and faster development, but it's totally up to you which approach you chose.
> The [Captain Rogers: Battle at Andromeda](https://rogers2.enclavegames.com/demo/) is built with Phaser and managing the controls is Phaser-based, but it could also be done in pure JavaScript. The good thing about using Phaser is that it offers helper variables and functions for easier and faster development, but it's totally up to you which approach you chose.
## Pure JavaScript approach

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/learn/forms/styling_web_forms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ For example, the date picker calendar, and the button on \<select> that displays
The articles [Advanced form styling](/en-US/docs/Learn/Forms/Advanced_form_styling) and [How to build custom form controls](/en-US/docs/Learn/Forms/How_to_build_custom_form_controls) describe how to style these.

> [!NOTE]
> some proprietary CSS pseudo-elements, such as {{cssxref('::-moz-range-track')}}, are capable of styling such internal components, but these aren't consistent across browsers, so aren't very reliable. We will mention these later.
> Some proprietary CSS pseudo-elements, such as {{cssxref('::-moz-range-track')}}, are capable of styling such internal components, but these aren't consistent across browsers, so aren't very reliable. We will mention these later.
## Styling simple form widgets

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ const ctx = canvas.getContext("2d");
```

> [!NOTE]
> other context values you could choose include `webgl` for WebGL, `webgl2` for WebGL 2, etc., but we won't need those in this article.
> Other context values you could choose include `webgl` for WebGL, `webgl2` for WebGL 2, etc., but we won't need those in this article.
So that's it — our canvas is now primed and ready for drawing on! The `ctx` variable now contains a {{domxref("CanvasRenderingContext2D")}} object, and all drawing operations on the canvas will involve manipulating this object.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ If everything is working correctly, you should see a page like this:
![The default start page when you create a new Ember app, with a cartoon mascot, saying congratulations](ember-start-page.png)
> [!NOTE]
> on Windows systems without [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/windows/wsl/install), you will experience slower build-times overall compared to macOS, Linux, and Windows _with_ WSL.
> On Windows systems without [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/windows/wsl/install), you will experience slower build-times overall compared to macOS, Linux, and Windows _with_ WSL.
## Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ There are [many plugins for rollup](https://github.com/rollup/awesome) that allo
From the point of view of a web server, a Svelte application is nothing more than a bunch of HTML, CSS, and JavaScript files. All you need is a web server capable of serving static files, which means you have plenty of options to choose from. Let's look at a couple of examples.
> [!NOTE]
> the following section could be applied to any client-side static website requiring a build step, not just Svelte apps.
> The following section could be applied to any client-side static website requiring a build step, not just Svelte apps.
### Deploying with Vercel
Expand Down Expand Up @@ -201,7 +201,7 @@ To deploy our app, follow these steps.
You can also [import a Svelte git project](https://vercel.com/import/svelte) into Vercel from [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), or [BitBucket](https://bitbucket.org/product).
> [!NOTE]
> you can globally install Vercel with `npm i -g vercel` so you don't have to use `npx` to run it.
> You can globally install Vercel with `npm i -g vercel` so you don't have to use `npx` to run it.
### Automatic deployment to GitLab pages
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ npm run dev # start the app in development
These instructions apply to any Svelte project you'd like to convert to TypeScript. Just take into account that the Svelte community is constantly improving Svelte TypeScript support, so you should run `npm update` regularly to take advantage of the latest changes.

> [!NOTE]
> if you find any trouble working with TypeScript inside a Svelte application, have a look at this [troubleshooting/FAQ section about TypeScript support](https://github.com/sveltejs/language-tools/blob/master/docs/preprocessors/typescript.md#troubleshooting--faq).
> If you find any trouble working with TypeScript inside a Svelte application, have a look at this [troubleshooting/FAQ section about TypeScript support](https://github.com/sveltejs/language-tools/blob/master/docs/preprocessors/typescript.md#troubleshooting--faq).
As we said before, TypeScript is a superset of JavaScript, so your application will run without modifications. Currently you will be running a regular JavaScript application with TypeScript support enabled, without taking advantage of any of the features that TypeScript provides. You can now start adding types progressively.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ We agree — testing all the things we've looked at in previous articles manuall
We will look at how to set up your own Selenium-based testing system in the next article. In this article, we'll look at how to set up a task runner, and use the basic functionality of commercial systems like the ones mentioned above.

> [!NOTE]
> the above two categories are not mutually exclusive. It is possible to set up a task runner to access a service like Sauce Labs, or LambdaTest via an API, run cross browser tests, and return results. We will look at this below as well.
> The above two categories are not mutually exclusive. It is possible to set up a task runner to access a service like Sauce Labs, or LambdaTest via an API, run cross browser tests, and return results. We will look at this below as well.
## Using a task runner to automate testing tools

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ Let's write an example:
> Sauce Labs' [Platform Configurator](https://saucelabs.com/platform/platform-configurator#/) is a useful tool for generating capability objects to feed to your driver instances, based on what browser/OS you want to test on.
> [!NOTE]
> for more useful details on testing with Sauce Labs and Selenium, check out [Getting Started with Selenium for Automated Website Testing](https://docs.saucelabs.com/web-apps/automated-testing/selenium/), and [Instant Selenium Node.js Tests](https://docs.saucelabs.com/web-apps/automated-testing/selenium/sample-scripts/#nodejs).
> For more useful details on testing with Sauce Labs and Selenium, check out [Getting Started with Selenium for Automated Website Testing](https://docs.saucelabs.com/web-apps/automated-testing/selenium/), and [Instant Selenium Node.js Tests](https://docs.saucelabs.com/web-apps/automated-testing/selenium/sample-scripts/#nodejs).
#### Filling in Sauce Labs test details programmatically
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Here, it is defined that when the global scope is of type `DedicatedWorkerGlobal
### Preferences

> [!NOTE]
> this information is specific to Gecko and should only be used in the Browser compatibility section.
> This information is specific to Gecko and should only be used in the Browser compatibility section.
In Gecko, the availability of a partial interface, including its constructor, properties and methods may be controlled by a preference (usually called a "pref"). This is marked in the WebIDL too.

Expand All @@ -189,7 +189,7 @@ interface SpeechSynthesis {
Here `media.webspeech.synth.enabled` controls the `SpeechSynthesis` interface and its properties (the full listing has more than 3.)

> [!NOTE]
> the default value of the preference is not available directly in the WebIDL (it can be different from one product using Gecko to another.)
> The default value of the preference is not available directly in the WebIDL (it can be different from one product using Gecko to another.)
### Available only in system code

Expand Down Expand Up @@ -404,7 +404,7 @@ For the documentation, the sub-page must contain a sentence indicating if it is
### Preferences

> [!NOTE]
> this information is specific to Gecko and should only be used in the Browser compatibility section.
> This information is specific to Gecko and should only be used in the Browser compatibility section.
In Gecko, the availability of some methods may be controlled by a preference. This is marked in the WebIDL too.

Expand Down Expand Up @@ -444,7 +444,7 @@ serializer; // Standard version
The `toJSON()` method is listed just like any other method of the interface and has its own sub-page (E.g. {{domxref("Performance.toJSON()")}})

> [!NOTE]
> the WebIDL specification uses `serializer` instead of `jsonifier`. This is not used in Gecko — only the non-standard likely early proposal `jsonifier` is found in mozilla-central.
> The WebIDL specification uses `serializer` instead of `jsonifier`. This is not used in Gecko — only the non-standard likely early proposal `jsonifier` is found in mozilla-central.
### Iterator-like methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To ensure proper formatting and syntax highlighting of code blocks, writers must
If the code block is pseudocode, the output of a command, or otherwise not a programming language, explicitly set the language to `plain`.

> [!WARNING]
> if the desired language is not yet supported by MDN, do **not** set the language of a code block to a similar language, as doing so may have unintended side effects with Prettier formatting and syntax highlighting.
> If the desired language is not yet supported by MDN, do **not** set the language of a code block to a similar language, as doing so may have unintended side effects with Prettier formatting and syntax highlighting.
### Code line length

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/mozilla/firefox/releases/21/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Firefox 21 was released on May 14, 2013. This article lists key changes that are

- Support for the spec-compliant `Content-Security-Policy` HTTP header (in addition to the experimental `X-Content-Security-Policy`) has been added ([Firefox bug 783049](https://bugzil.la/783049)).
> [!NOTE]
> the patch for this new header landed in Firefox 21, it is disabled on builds ([Firefox bug 842657](https://bugzil.la/842657)).
> The patch for this new header landed in Firefox 21, it is disabled on builds ([Firefox bug 842657](https://bugzil.la/842657)).
### Worker

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ From the assistive technology user's perspective, the heading does not exist sin
- : The radio is not checked.

> [!NOTE]
> use the [`tabindex` attribute](/en-US/docs/Web/HTML/Global_attributes/tabindex) if the `role="radio"` is used on an element that does not natively accept keyboard focus. E.g., a `<div>` or `<span>`.
> Use the [`tabindex` attribute](/en-US/docs/Web/HTML/Global_attributes/tabindex) if the `role="radio"` is used on an element that does not natively accept keyboard focus. E.g., a `<div>` or `<span>`.
## Keyboard interactions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ By default, when people use the tab key to browse a webpage, only interactive el
The order in which elements gain focus when using a keyboard, is the source order by default. In exceptional circumstances, authors may want to redefine the order. To do this, authors can set `tabindex` to any positive number.

> [!WARNING]
> avoid using positive values for `tabindex`. Elements with a positive `tabindex` are put before the default interactive elements on the page, which means page authors will have to set (and maintain) `tabindex` values for all focusable elements on the page whenever they use one or more positive values for `tabindex`.
> Avoid using positive values for `tabindex`. Elements with a positive `tabindex` are put before the default interactive elements on the page, which means page authors will have to set (and maintain) `tabindex` values for all focusable elements on the page whenever they use one or more positive values for `tabindex`.
The following table describes `tabindex` behavior in modern browsers:

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/attr/namespaceuri/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The namespace URI is set at the {{domxref("Attr")}} creation and cannot be chang
An attribute with a namespace can be created using {{domxref("Element.setAttributeNS()")}}.

> [!NOTE]
> an attribute does not inherit its namespace from the element it is attached to.
> An attribute does not inherit its namespace from the element it is attached to.
> If an attribute is not explicitly given a namespace, it has no namespace.
The browser does not handle or enforce namespace validation per se. It is up to the JavaScript
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/baseaudiocontext/createbuffer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ on an `AudioContext` running at 44100Hz, will be automatically \*resampled\* to
44100Hz = 1 second.

> [!NOTE]
> audio resampling is very similar to image resizing: say you've
> Audio resampling is very similar to image resizing: say you've
> got a 16 x 16 image, but you want it to fill a 32x32 area: you resize (resample) it.
> the result has less quality (it can be blurry or edgy, depending on the resizing
> algorithm), but it works, and the resized image takes up less space. Resampled audio
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/baseaudiocontext/listener/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ An {{ domxref("AudioListener") }} object.
## Examples

> [!NOTE]
> for a full Web Audio spatialization example, see our [panner-node](https://github.com/mdn/webaudio-examples/tree/main/panner-node) demo.
> For a full Web Audio spatialization example, see our [panner-node](https://github.com/mdn/webaudio-examples/tree/main/panner-node) demo.
```js
const audioCtx = new AudioContext();
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/baseaudiocontext/samplerate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ second.
## Examples

> [!NOTE]
> for a full Web Audio example implementation, see one of our
> For a full Web Audio example implementation, see one of our
> Web Audio Demos on the [MDN GitHub repo](https://github.com/mdn/webaudio-examples). Try entering
> `audioCtx.sampleRate` into your browser console.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ if (canvas.getContext) {
Here is a minimalistic template, which we'll be using as a starting point for later examples.

> [!NOTE]
> it is not good practice to embed a script inside HTML. We do it here to keep the example concise.
> It is not good practice to embed a script inside HTML. We do it here to keep the example concise.
```html
<!doctype html>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cspviolationreportbody/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ browser-compat: api.CSPViolationReportBody
The `CSPViolationReportBody` interface contains the report data for a Content Security Policy (CSP) violation. CSP violations are thrown when the webpage attempts to load a resource that violates the CSP set by the {{HTTPHeader("Content-Security-Policy")}} HTTP header.

> [!NOTE]
> this interface is similar, but not identical to, the [JSON objects](/en-US/docs/Web/HTTP/CSP#violation_report_syntax) sent back to the [`report-uri`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-uri) or [`report-to`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-to) policy directive of the {{HTTPHeader("Content-Security-Policy")}} header.
> This interface is similar, but not identical to, the [JSON objects](/en-US/docs/Web/HTTP/CSP#violation_report_syntax) sent back to the [`report-uri`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-uri) or [`report-to`](/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/report-to) policy directive of the {{HTTPHeader("Content-Security-Policy")}} header.
{{InheritanceDiagram}}

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/headers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can retrieve a `Headers` object via the {{domxref("Request.headers")}} and {
An object implementing `Headers` can directly be used in a {{jsxref("Statements/for...of", "for...of")}} structure, instead of {{domxref('Headers.entries()', 'entries()')}}: `for (const p of myHeaders)` is equivalent to `for (const p of myHeaders.entries())`.

> [!NOTE]
> you can find out more about the available headers by reading our [HTTP headers](/en-US/docs/Web/HTTP/Headers) reference.
> You can find out more about the available headers by reading our [HTTP headers](/en-US/docs/Web/HTTP/Headers) reference.
## Constructor

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmlslotelement/assign/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ browser-compat: api.HTMLSlotElement.assign
The **`assign()`** method of the {{domxref("HTMLSlotElement")}} interface sets the slot's _manually assigned nodes_ to an ordered set of slottables. The manually assigned nodes set is initially empty until nodes are assigned using `assign()`.

> [!NOTE]
> you cannot mix manually (imperative) and named (declarative, automatic) slot assignments. Therefore, for this method to work, the shadow tree needs to have been [created](/en-US/docs/Web/API/Element/attachShadow) with the `slotAssignment: "manual"` option.
> You cannot mix manually (imperative) and named (declarative, automatic) slot assignments. Therefore, for this method to work, the shadow tree needs to have been [created](/en-US/docs/Web/API/Element/attachShadow) with the `slotAssignment: "manual"` option.
## Syntax

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ browser-compat: api.HTMLSlotElement.slotchange_event
The **`slotchange`** event is fired on an {{DOMxRef("HTMLSlotElement")}} instance ({{HTMLElement("slot")}} element) when the node(s) contained in that slot change.

> [!NOTE]
> the `slotchange` event doesn't fire if the children of a slotted node change — only if you change (e.g. add or delete) the actual nodes themselves.
> The `slotchange` event doesn't fire if the children of a slotted node change — only if you change (e.g. add or delete) the actual nodes themselves.
In order to trigger a **slotchange** event, one has to set or remove the `slot` attribute.

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmltablecellelement/abbr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ indicates an abbreviation associated with the cell. If the cell does not represe
It reflects the `abbr` attribute of the {{HTMLElement("th")}} element.

> [!NOTE]
> this property doesn't have a visual effect in browsers. It adds information to help assistive technology like screenreaders that can use this abbreviation
> This property doesn't have a visual effect in browsers. It adds information to help assistive technology like screenreaders that can use this abbreviation
## Value

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmltablecellelement/scope/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ indicates the scope of a {{HTMLElement("th")}} cell.
Header cells can be configured, using the `scope` attribute, to apply to a specified row or column, or to the not-yet-scoped cells within the current row group (that is, the same ancestor {{HTMLElement("thead")}}, {{HTMLElement("tbody")}}, or {{HTMLElement("tfoot")}} element). If no value is specified for `scope`, the header is not associated directly with cells in this way. Permitted values for `scope` are:

> [!NOTE]
> this property doesn't have a visual effect in browsers. It adds semantic information to help assistive technology like screenreaders to present the table in a more coherent way.
> This property doesn't have a visual effect in browsers. It adds semantic information to help assistive technology like screenreaders to present the table in a more coherent way.
## Value

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/idbcursor/direction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ cursor to iterate through all the records in the object store. Within each itera
log the direction of the cursor.

> [!NOTE]
> we can't change the direction of travel of the cursor using
> We can't change the direction of travel of the cursor using
> the `direction` property, as it is read-only. We specify the direction of
> travel using the 2nd argument of {{domxref("IDBObjectStore.openCursor")}}.
Expand Down
Loading

0 comments on commit 4dec42e

Please sign in to comment.