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

SAB tweaks #782

Merged
merged 21 commits into from
Feb 1, 2017
Merged

SAB tweaks #782

merged 21 commits into from
Feb 1, 2017

Conversation

jmdyck
Copy link
Collaborator

@jmdyck jmdyck commented Jan 25, 2017

All editorial.

jmdyck added 21 commits January 24, 2017 23:40
The emu-clause for "Memory Model" contains some introductory stuff,
followed by a bunch of sub-emu-clauses,
followed by 3 emu-notes.
Now, although these notes are (in the HTML)
children of the Memory Model clause,
I suspect that when rendered,
they'll *look* like they're part of
the last of the sub-clauses ("Data Race Freedom"),
which you probably don't want.

So, to prevent this, I put the three notes in their own sub-clause.
It's unusual (at least in this document)
for a <li> to contain both inline items (<em> and text) and block items (<p>).
Embed the inline items in a <p>.

(Also, adjust the linebreaking and indenting accordingly.)
"the empty list" -> "a new empty List" or "an empty List" as appropriate

"an empty List"  -> "a new empty List"
For one thing, 0 (per se) doesn't exist as an ES value.
More generally, spec algorithms can use abstract/mathematical integers
without having to relate them to Number values.
(Should maybe be "Chosen Value Record".)
This is a case of "dangling else" (or "dangling otherwise"),
and it's not obvious which "if" the "otherwise" associates with.

I've rewritten it to remove the ambiguity.
Please check whether I got the intent right.
(If not, you might want to rewrite as multiple steps,
so that the logic is clear.)
@bterlson
Copy link
Member

bterlson commented Feb 1, 2017

Thanks for this. I especially like the subclause for the guide notes.

@bterlson bterlson merged commit 7ef4f1d into tc39:sab-integration Feb 1, 2017
bterlson pushed a commit that referenced this pull request Feb 1, 2017
* Editorial: put Memory Model notes in their own subclause

The emu-clause for "Memory Model" contains some introductory stuff,
followed by a bunch of sub-emu-clauses,
followed by 3 emu-notes.
Now, although these notes are (in the HTML)
children of the Memory Model clause,
I suspect that when rendered,
they'll *look* like they're part of
the last of the sub-clauses ("Data Race Freedom"),
which you probably don't want.

So, to prevent this, I put the three notes in their own sub-clause.

* Editorial: in <li> with block items, put inline items in <p>

It's unusual (at least in this document)
for a <li> to contain both inline items (<em> and text) and block items (<p>).
Embed the inline items in a <p>.

(Also, adjust the linebreaking and indenting accordingly.)

* Editorial: Add </li> tags

* Editorial: insert missing </emu-xref> tag

* Editorial: fix misspelled </emu-xref> tag

* Editorial: insert missing close-backticks

* Editorial: put missing underscores around metavariables

* Editorial: put missing asterisks around "true"

* Editorial: put missing backticks around string literal

* Editorial: insert missing "that"

* Editorial: change "the List" to "a List" in a few places

* Editorial: various wording tweaks re empty List

"the empty list" -> "a new empty List" or "an empty List" as appropriate

"an empty List"  -> "a new empty List"

* Editorial: remove asterisks from *0* and *1*

For one thing, 0 (per se) doesn't exist as an ES value.
More generally, spec algorithms can use abstract/mathematical integers
without having to relate them to Number values.

* Editorial: add "Record" to anonymous record constructors

(Should maybe be "Chosen Value Record".)

* Editorial: delete pointless Zero-Width Joiner

* Editorial: remove extra indent on 2 algorithm steps

* Editorial: insert and delete a few spaces

* Editorial: insert comma before "then"

* Editorial: misc tweaks to algorithm wording

... mostly for consistency

* Editorial: change "a event" to "an event"

* Editorial: disambiguate a dangling else

This is a case of "dangling else" (or "dangling otherwise"),
and it's not obvious which "if" the "otherwise" associates with.

I've rewritten it to remove the ambiguity.
Please check whether I got the intent right.
(If not, you might want to rewrite as multiple steps,
so that the logic is clear.)
bterlson added a commit that referenced this pull request Feb 1, 2017
Squashed commit of the following:

commit d617a6e
Author: jmdyck <jmdyck@ibiblio.org>
Date:   Wed Feb 1 13:47:27 2017 -0800

    Editorial: SAB editorial tweaks (#782)

    * Editorial: put Memory Model notes in their own subclause

    The emu-clause for "Memory Model" contains some introductory stuff,
    followed by a bunch of sub-emu-clauses,
    followed by 3 emu-notes.
    Now, although these notes are (in the HTML)
    children of the Memory Model clause,
    I suspect that when rendered,
    they'll *look* like they're part of
    the last of the sub-clauses ("Data Race Freedom"),
    which you probably don't want.

    So, to prevent this, I put the three notes in their own sub-clause.

    * Editorial: in <li> with block items, put inline items in <p>

    It's unusual (at least in this document)
    for a <li> to contain both inline items (<em> and text) and block items (<p>).
    Embed the inline items in a <p>.

    (Also, adjust the linebreaking and indenting accordingly.)

    * Editorial: Add </li> tags

    * Editorial: insert missing </emu-xref> tag

    * Editorial: fix misspelled </emu-xref> tag

    * Editorial: insert missing close-backticks

    * Editorial: put missing underscores around metavariables

    * Editorial: put missing asterisks around "true"

    * Editorial: put missing backticks around string literal

    * Editorial: insert missing "that"

    * Editorial: change "the List" to "a List" in a few places

    * Editorial: various wording tweaks re empty List

    "the empty list" -> "a new empty List" or "an empty List" as appropriate

    "an empty List"  -> "a new empty List"

    * Editorial: remove asterisks from *0* and *1*

    For one thing, 0 (per se) doesn't exist as an ES value.
    More generally, spec algorithms can use abstract/mathematical integers
    without having to relate them to Number values.

    * Editorial: add "Record" to anonymous record constructors

    (Should maybe be "Chosen Value Record".)

    * Editorial: delete pointless Zero-Width Joiner

    * Editorial: remove extra indent on 2 algorithm steps

    * Editorial: insert and delete a few spaces

    * Editorial: insert comma before "then"

    * Editorial: misc tweaks to algorithm wording

    ... mostly for consistency

    * Editorial: change "a event" to "an event"

    * Editorial: disambiguate a dangling else

    This is a case of "dangling else" (or "dangling otherwise"),
    and it's not obvious which "if" the "otherwise" associates with.

    I've rewritten it to remove the ambiguity.
    Please check whether I got the intent right.
    (If not, you might want to rewrite as multiple steps,
    so that the logic is clear.)

commit de25d0e
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Mon Jan 23 11:02:03 2017 -0800

    Editorial: fix markup (#772)

commit a845dcf
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Fri Jan 20 13:17:07 2017 -0800

    Normative: add Atomics[@@toStringTag]

commit 7f3ede5
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Fri Jan 20 13:16:58 2017 -0800

    Editorial: fix section id for Atomics.xor

commit b0d222f
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 18:32:46 2017 -0800

    Normative: integrate SharedArrayBuffer proposal sections 6.3.4 to 6.3.6 as notes at the end of the memory model section

commit f58f32d
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 18:08:16 2017 -0800

    Normative: fix race wording around execution

commit dfafcd8
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 18:06:04 2017 -0800

    Normative: memory-order constraint fix

commit fa85a87
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 17:52:58 2017 -0800

    Normative: integrate SharedArrayBuffer proposal sections 6.3.1 to 6.3.3

commit cc5a78a
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 16:13:17 2017 -0800

    Normative: integrate SharedArrayBuffer proposal sections 6.1 and 6.2

commit f9e0fcd
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 14:27:57 2017 -0800

    Normative: integrate SharedArrayBuffer proposal section 4

commit 034da0d
Author: Shu-yu Guo <shu@rfrn.org>
Date:   Thu Jan 19 14:25:32 2017 -0800

    Normative: integrate SharedArrayBuffer proposal section 2

commit 0378ed6
Author: Brian Terlson <brian.terlson@microsoft.com>
Date:   Thu Jan 19 14:57:18 2017 -0800

    Normative: Implement SAB clause 5

commit 3fcbfd7
Author: Brian Terlson <brian.terlson@microsoft.com>
Date:   Thu Jan 19 14:39:31 2017 -0800

    Editorial: Globally unique value

commit 7df8ec7
Author: Brian Terlson <brian.terlson@microsoft.com>
Date:   Thu Jan 19 14:38:15 2017 -0800

    Normative: add some missing parts from SAB clause 3

commit df65e7d
Author: Brian Terlson <brian.terlson@microsoft.com>
Date:   Thu Jan 19 14:18:21 2017 -0800

    Normative: implement SAB clause 3
@jmdyck jmdyck deleted the sab_tweaks branch February 13, 2018 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants