Skip to content

Commit 702cd9e

Browse files
Bashamegagithub-actions[bot]caugnerJosh-Cena
authored
docs: add missing comma after "i.e." for clarity (#38905)
* docs: add missing comma after "i.e." for clarity * feat: add new linter configuration * - * revert * - * Update files/en-us/web/api/webgl_api/constants/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/web/api/webgl_api/constants/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update .markdownlint.jsonc Co-authored-by: Claas Augner <495429+caugner@users.noreply.github.com> * fix: format json * feat: commas for e.g. * chore: disable eslint rule * chore: disable eslint rule * Update files/en-us/mdn/writing_guidelines/writing_style_guide/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update files/en-us/mdn/writing_guidelines/writing_style_guide/index.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * - * Fix --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Claas Augner <495429+caugner@users.noreply.github.com> Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
1 parent 43f272a commit 702cd9e

974 files changed

Lines changed: 1648 additions & 1626 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.markdownlint.jsonc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,20 @@
231231
"searchPattern": "/^ *> !?\\[!?((?!NOTE)[Nn][Oo][Tt][Ee]|(?!WARNING)[Ww][Aa][Rr][Nn][Ii][Nn][Gg]|(?!CALLOUT)[Cc][Aa][Ll][Ll][Oo][Uu][Tt])\\]\\n|^ *> (?!\\[!)!?\\[!?(NOTE|WARNING|CALLOUT)\\]\\n/gm",
232232
"searchScope": "text",
233233
},
234+
{
235+
"name": "comma-after-ie",
236+
"message": "Add comma after 'i.e.'",
237+
"searchPattern": "/\\bi\\.e\\. /g",
238+
"replace": "i.e., ",
239+
"searchScope": "text",
240+
},
241+
{
242+
"name": "comma-after-eg",
243+
"message": "Add comma after 'e.g.'",
244+
"searchPattern": "/\\be\\.g\\. /g",
245+
"replace": "e.g., ",
246+
"searchScope": "text",
247+
},
234248
],
235249
},
236250
}

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ yarn content move <from-slug> <to-slug> [locale]
251251
To use `yarn content move`, provide the slug of the document you'd like to move (e.g., `Learn/Accessibility`), and the slug of its new location (e.g., `Learn/A11y`).
252252
The locale of the existing document can be provided as an optional third argument (this defaults to `en-US`). For other locales,
253253
`CONTENT_TRANSLATED_ROOT` has to be set correctly in your environment.
254-
If the document you'd like to move contains child documents (i.e. it represents a document tree), the `yarn content move` command will move the entire tree.
254+
If the document you'd like to move contains child documents (i.e., it represents a document tree), the `yarn content move` command will move the entire tree.
255255

256256
Let's say you want to move the entire `/en-US/Learn/Accessibility` tree to `/en-US/Learn/A11y`, you can do so as follows:
257257

‎REVIEWING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ out-of-date. This is being handled as follows:
2323

2424
1. Different MDN staff members and volunteers have been assigned as "topic
2525
review owners", meaning that when a pull request comes in related to a
26-
particular topic area of the site (e.g. the CSS reference, or the learning
26+
particular topic area of the site (e.g., the CSS reference, or the learning
2727
area), it will be assigned to that area's topic review owner(s) and they
2828
will receive an email notification asking for a review. This is being
2929
handled using a [CODEOWNERS](https://github.com/mdn/content/blob/main/.github/CODEOWNERS)

‎files/en-us/games/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ We've also included a reference section so you can easily find information about
1919
2020
## Port native games to the Web
2121

22-
If you are a native developer (for example writing games in C++), and you are interested in how you can port your games over to the Web, you should learn more about our [Emscripten](https://emscripten.org/index.html) tool — this is an LLVM to JavaScript compiler, which takes LLVM bytecode (e.g. generated from C/C++ using Clang, or from another language) and compiles that into [asm.js](/en-US/docs/Games/Tools/asm.js), which can be run on the Web.
22+
If you are a native developer (for example writing games in C++), and you are interested in how you can port your games over to the Web, you should learn more about our [Emscripten](https://emscripten.org/index.html) tool — this is an LLVM to JavaScript compiler, which takes LLVM bytecode (e.g., generated from C/C++ using Clang, or from another language) and compiles that into [asm.js](/en-US/docs/Games/Tools/asm.js), which can be run on the Web.
2323

2424
To get started, see:
2525

‎files/en-us/games/publishing_games/game_distribution/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You don't have to tell people to search for your game in an app store with HTML
3030

3131
The vast majority of the traffic we are interested in — people playing HTML games — comes from mobile devices so that's something you will have to focus on if you truly want to succeed. Mobile devices are where HTML technology can truly shine and show its advantages. There's no Flash, and HTML is fully multiplatform.
3232

33-
Trying to compete with desktop games directly is very difficult. You can put your HTML games into the same arena (see [Native desktop](#native_desktop), later on) and you should because it's good to diversify the platforms you support, but you have to remember that developers creating desktop games have years of experience, great tools and stable distribution channels. Many HTML games will target different market segments than native desktop games, e.g. simple time killer games to be played while on the move rather than huge immersive experiences. Such games are often designed to be played with two, or even one finger, so you can hold the device, play the game and be able to use the second hand for whatever you currently need.
33+
Trying to compete with desktop games directly is very difficult. You can put your HTML games into the same arena (see [Native desktop](#native_desktop), later on) and you should because it's good to diversify the platforms you support, but you have to remember that developers creating desktop games have years of experience, great tools and stable distribution channels. Many HTML games will target different market segments than native desktop games, e.g., simple time killer games to be played while on the move rather than huge immersive experiences. Such games are often designed to be played with two, or even one finger, so you can hold the device, play the game and be able to use the second hand for whatever you currently need.
3434

3535
Saying this, desktop platforms can be used for distribution quite easily with the availability of wrappers that can help you prepare native builds of your game see [Packaging games](#packaging_games). It's also nice to provide desktop controls for your games even if you're mostly targeting mobile. Players are enjoying your games on any platform available, and desktop is one of them. Plus, it is usually easier to build and test the game first on desktop, and then move on to debugging mobile.
3636

‎files/en-us/games/techniques/2d_collision_detection/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page-type: guide
66

77
{{GamesSidebar}}
88

9-
Algorithms to detect collision in 2D games depend on the type of shapes that can collide (e.g. Rectangle to Rectangle, Rectangle to Circle, Circle to Circle). Generally you will have a simple generic shape that covers the entity known as a "hitbox" so even though collision may not be pixel perfect, it will look good enough and be performant across multiple entities. This article provides a review of the most common techniques used to provide collision detection in 2D games.
9+
Algorithms to detect collision in 2D games depend on the type of shapes that can collide (e.g., Rectangle to Rectangle, Rectangle to Circle, Circle to Circle). Generally you will have a simple generic shape that covers the entity known as a "hitbox" so even though collision may not be pixel perfect, it will look good enough and be performant across multiple entities. This article provides a review of the most common techniques used to provide collision detection in 2D games.
1010

1111
## Axis-Aligned Bounding Box
1212

‎files/en-us/games/techniques/3d_collision_detection/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ function intersect(a, b) {
7777

7878
## Bounding spheres
7979

80-
Using bounding spheres to detect collisions is a bit more complex than AABB, but still fairly quick to test. The main advantage of spheres is that they are invariant to rotation, so if the wrapped entity rotates, the bounding sphere would still be the same. Their main disadvantage is that unless the entity they are wrapping is actually spherical, the wrapping is usually not a good fit (i.e. wrapping a person with a bounding sphere will cause a lot of false positives, whereas an AABB would be a better match).
80+
Using bounding spheres to detect collisions is a bit more complex than AABB, but still fairly quick to test. The main advantage of spheres is that they are invariant to rotation, so if the wrapped entity rotates, the bounding sphere would still be the same. Their main disadvantage is that unless the entity they are wrapping is actually spherical, the wrapping is usually not a good fit (i.e., wrapping a person with a bounding sphere will cause a lot of false positives, whereas an AABB would be a better match).
8181

8282
### Point vs. sphere
8383

‎files/en-us/games/techniques/3d_on_the_web/building_up_a_basic_demo_with_a-frame/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Adding the cube to the scene is done by adding a simple [`<a-box>`](https://afra
7474
```
7575

7676
It contains a few parameters already defined: `color`, `position` and `rotation` — these are fairly obvious, and define the base color of the cube, the position inside the 3D scene, and the rotation of the cube.
77-
The distance values (e.g. for the cube y position) are unitless, and can basically be anything you deem suitable for your scene — millimeters, meters, feet, or miles — it's up to you.
77+
The distance values (e.g., for the cube y position) are unitless, and can basically be anything you deem suitable for your scene — millimeters, meters, feet, or miles — it's up to you.
7878

7979
### Adding a background: Sky box
8080

‎files/en-us/games/techniques/3d_on_the_web/building_up_a_basic_demo_with_three.js/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ There are other types of camera available (Cube, Orthographic), but the simplest
122122
- The `z` position, with the value of 50 units, is the distance between the camera and the center of the scene on the `z` axis. Here we're moving the camera back, so the objects in the scene can be viewed. 50 feels about right. It's not too near, or too far, and the sizes of the objects allow them to stay on the scene, within the given field of view. The `x` and `y` values, if not specified, will default to 0.
123123

124124
You should experiment with these values and see how they change what you see in the scene.
125-
The distance values (e.g. for the camera z position) are unitless, and can be anything you deem suitable for your scene: millimeters, meters, feet, or miles. It's up to you.
125+
The distance values (e.g., for the camera z position) are unitless, and can be anything you deem suitable for your scene: millimeters, meters, feet, or miles. It's up to you.
126126

127127
## Rendering the scene
128128

‎files/en-us/games/techniques/control_mechanisms/desktop_with_gamepad/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The Gamepad API gives you the ability to connect a gamepad to your computer and
1414

1515
## API status, browser and hardware support
1616

17-
The [Gamepad API](/en-US/docs/Web/API/Gamepad_API) is still in Working Draft status, although browser support is already quite good — around 63% global coverage, according to [caniuse.com](https://caniuse.com/#search=gamepad). The list of supported devices is also quite extensive — most popular gamepads (e.g. XBox 360 or PS3) should be suitable for web implementations.
17+
The [Gamepad API](/en-US/docs/Web/API/Gamepad_API) is still in Working Draft status, although browser support is already quite good — around 63% global coverage, according to [caniuse.com](https://caniuse.com/#search=gamepad). The list of supported devices is also quite extensive — most popular gamepads (e.g., XBox 360 or PS3) should be suitable for web implementations.
1818

1919
## Pure JavaScript approach
2020

@@ -105,7 +105,7 @@ function draw() {
105105
In this case, we are checking the four D-Pad buttons (0-3) and the A button (11).
106106

107107
> [!NOTE]
108-
> Please remember that different devices may have different key mappings, i.e. the D-Pad Right button have an index of 3 on the wireless XBox 360, but may have a different one on another device.
108+
> Please remember that different devices may have different key mappings, i.e., the D-Pad Right button have an index of 3 on the wireless XBox 360, but may have a different one on another device.
109109
110110
You could also create a helper function that would assign proper names to the listed buttons, so for example instead of checking out if `gamepadButtonPressedHandler(3)` is pressed, you could do a more descriptive check: `gamepadButtonPressedHandler('DPad-Right')`.
111111

0 commit comments

Comments
 (0)