Editorial: various edits for style and clarity #128
Conversation
|
I think these all look great! Would you mind resolving the conflicts so I can see a cleaner diff? Sorry I merged 2 things in early today that conflict. |
* Use consistent wording in various places
(e.g., "Source Map format")
* Use more spec-like language where it makes sense
* Fixed a note to render correctly
* Link terms more consistently
* Reworded some prose for clarity
* Remove <ins> tag
takikawa
force-pushed
the
editorial-fixes
branch
from
be5e1bb to
f18f8cb
Compare
Thanks for the review! It should be rebased & conflicts resolved now. |
source-map.bs
Outdated
| * Support source-level debugging allowing bidirectional mapping | ||
| * Support server-side stack trace deobfuscation | ||
|
|
||
| The original source map format (v1) was created by Joseph Schorr for use by | ||
| The original Source Map format (v1) was created by Joseph Schorr for use by |
There was a problem hiding this comment.
The casing seems inconsistent. Here we sentence case but then below it's lower case. I'm not sure if we care?
There was a problem hiding this comment.
The way I understood it is it upper cases "Source Map format" but for concrete real instances of "source maps" we lower-case it?
There was a problem hiding this comment.
My preference would be to always write it following the case sentence where it's written:
- "An Introduction to Source Maps"
- "Source maps are ..."
- "When we talk about source maps, ..."
- "The source map specification says that ..."
- "./decode-source-map.js"
There was a problem hiding this comment.
@nicolo-ribaudo so then in this case, according to your preferred format, we should use "The original source map format"?
|
|
||
| <h2 class="no-num">Introduction</h2> | ||
|
|
||
| This Ecma standard defines the Source Map format, used for mapping transpiled source code back to the original sources. | ||
| This Ecma Standard defines the Source Map Format, used for mapping transpiled source code back to the original sources. |
There was a problem hiding this comment.
I made "source map format" generally lowercase now, except in two locations where I think it's really intended as a proper noun as the object that the standard is defining (this spot and one more below).
Also capitalized "Standard" here since it's also done that way below, and in the intro of ES262:
I can revise this if we want to make this lowercase too though.
Make casing of "source map format" consistent with English context, normally lowercase unless it's used as a proper noun.
takikawa
force-pushed
the
editorial-fixes
branch
from
b7c85fa to
71de3d0
Compare
SHA: eb86a23 Reason: push, by jkup Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This PR shouldn't make any semantic changes and should be purely editorial. It adjusts markup and rewords prose for consistency, clarity, or more spec-like wording. (the commit message has more details)
It builds on PR #126 so should be rebased & merged after that.