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

Editorial: "a new empty List" -> "« »" #2666

Merged
merged 1 commit into from
Mar 2, 2022

Conversation

ljharb
Copy link
Member

@ljharb ljharb commented Feb 15, 2022

Peeled this out of #2547.

@michaelficarra
Copy link
Member

This change was actually mostly done by accident in #2547. It started by changing "Return a new Empty List" to "Return Completion(« »)" (since lists in AO arguments are written that way), and then later stripping out unneeded Completion applications to arrive at "Return « »". I'm not sure if it's a great idea to just make this change everywhere though. Let's talk about it in the editor call.

@michaelficarra michaelficarra added the editor call to be discussed in the next editor call label Feb 15, 2022
@bakkot
Copy link
Contributor

bakkot commented Feb 15, 2022

Previously: #2201

@bakkot
Copy link
Contributor

bakkot commented Feb 17, 2022

For empty lists, I think:

  • we should use « » consistently when in argument lists, including arguments to SDOs
  • when returning a new empty list we should say Return a new empty List. rather than using « »

I offer no commentary on what to do in other cases, but we should presumably default to leaving them as they are unless we are able to write down a consistent rule (which isn't necessarily worth doing).

@michaelficarra
Copy link
Member

The rule about AO arg lists applies to non-empty lists as well.

@ljharb
Copy link
Member Author

ljharb commented Feb 17, 2022

I've updated the PR to meet those criteria.

spec.html Outdated Show resolved Hide resolved
spec.html Outdated Show resolved Hide resolved
spec.html Outdated Show resolved Hide resolved
@ljharb
Copy link
Member Author

ljharb commented Feb 23, 2022

Here's the current rubric as discussed for "a new empty list":

  • we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
  • when returning a new empty list from an AO/SDO, we should use prose
  • when initializing or defaulting an alias to an empty list, use prose
  • for everything else, leave as-is ("author's choice"), for now

I'll update this PR to match, and to resolve the above comments.

spec.html Outdated Show resolved Hide resolved
ljharb added a commit to ljharb/ecma262 that referenced this pull request Feb 24, 2022
…o;" (tc39#2666)

Rubric used:
 - we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
 - when returning a new empty list from an AO/SDO, we should use prose
 - when initializing or defaulting an alias to an empty list, use prose
 - for everything else, leave as-is ("author's choice"), for now
ljharb added a commit to ljharb/ecma262 that referenced this pull request Feb 24, 2022
…o;" (tc39#2666)

Rubric used:
 - we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
 - when returning a new empty list from an AO/SDO, we should use prose
 - when initializing or defaulting an alias to an empty list, use prose
 - for everything else, leave as-is ("author's choice"), for now
@ljharb
Copy link
Member Author

ljharb commented Feb 24, 2022

Updated; the diff is now much smaller.

@michaelficarra
Copy link
Member

@ljharb Can you give us a sampling of the cases that could change (in either direction) but did not fall into any of the above rules?

@ljharb
Copy link
Member Author

ljharb commented Feb 24, 2022

The remaining cases seem to be mostly "in a table", "in prose", or "in a list of key/value pairs when completing a Record", for which i went with syntax, prose, syntax, respectively.

ljharb added a commit to ljharb/ecma262 that referenced this pull request Feb 24, 2022
…o;" (tc39#2666)

Rubric used:
 - we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
 - when returning a new empty list from an AO/SDO, we should use prose
 - when initializing or defaulting an alias to an empty list, use prose
 - for everything else, leave as-is ("author's choice"), for now
Copy link
Contributor

@bakkot bakkot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't review for completeness, but what's here LGTM

@michaelficarra
Copy link
Member

@ljharb Those seem like the choices I would make, too. We can take a look at those examples together in the next editor call to see if we can agree on further rules.

@michaelficarra michaelficarra removed the editor call to be discussed in the next editor call label Mar 2, 2022
ljharb added a commit to ljharb/ecma262 that referenced this pull request Mar 2, 2022
…o;" (tc39#2666)

Rubric used:
 - we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
 - when returning a new empty list from an AO/SDO, we should use prose
 - when initializing or defaulting an alias to an empty list, use prose
 - for everything else, leave as-is ("author's choice"), for now
@michaelficarra michaelficarra added the ready to merge Editors believe this PR needs no further reviews, and is ready to land. label Mar 2, 2022
…o;" (tc39#2666)

Rubric used:
 - we should use syntax consistently when in argument lists, including arguments to SDOs, for both empty and non-empty lists
 - when returning a new empty list from an AO/SDO, we should use prose
 - when initializing or defaulting an alias to an empty list, use prose
 - for everything else, leave as-is ("author's choice"), for now
@ljharb ljharb merged commit 0bf22a9 into tc39:main Mar 2, 2022
@ljharb ljharb deleted the new-list branch March 2, 2022 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial change establishes editorial conventions ready to merge Editors believe this PR needs no further reviews, and is ready to land.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants