Adjust the language used in some of the documentation #31583
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
six-shot
changed the title
mrobinson
requested changes
Mar 8, 2024
docs/components/webxr.md
Outdated
Comment on lines
17
to
20
| * [surfman](https://github.com/servo/webxr/blob/main/webxr/glwindow/mod.rs#L448-L452) is a crate that abstracts away platform-specific details of OpenGL hardware-accelerated rendering | ||
| * a [surface](https://doc.servo.org/surfman/platform/unix/default/surface/type.Surface.html) is a hardware buffer that are tied to a specific OpenGL context | ||
| * a [surface texture](https://doc.servo.org/surfman/platform/unix/default/surface/type.SurfaceTexture.html) is an OpenGL texture that wraps a surface. Surface textures can be shared between OpenGL contexts. | ||
| * a [surfman context](https://doc.servo.org/surfman/platform/unix/default/context/type.Context.html) represents a particular OpenGL context, and is backed by platform-specific implementations (such as EGL on Unix-based platforms) |
There was a problem hiding this comment.
I don't think it makes sense to capitalize surfman here since the name of the project starts with lower-case letter.
There was a problem hiding this comment.
i Would fix it now sir
docs/components/style.md
Outdated
Comment on lines
3
to
4
| This document provides an overview of Servo's style system. For more extensive details, refer to the [style doc comments][style-doc], or the [Styling | ||
| Overview][wiki-styling-overview] in the wiki, which includes a conversation between |
There was a problem hiding this comment.
Please try to preserve the line length here.
docs/COMMAND_LINE_ARGS.md
Outdated
| @@ -11,7 +11,7 @@ Only arguments that need more explanation will be documented here. | |||
|
|
|||
| # Run | |||
| ## Enable Experimental Features | |||
| Use `--pref` to enable experimental features like experimental DOM API, JavaScript API and CSS properties. | |||
| Use `--pref` to enable experimental features like the experimental DOM API, JavaScript API and CSS properties. | |||
There was a problem hiding this comment.
Suggested change
| Use `--pref` to enable experimental features like the experimental DOM API, JavaScript API and CSS properties. | |
| Use `--pref` to enable experimental features like experimental DOM APIs, JavaScript APIs and CSS properties. |
mrobinson
changed the title
mrobinson
changed the title
Co-authored-by: Martin Robinson <mrobinson@igalia.com>
mrobinson
approved these changes
Mar 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
./mach build -ddoes not report any errors./mach test-tidydoes not report any errors