Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Integrate spec text into ES text with change bars? #92

Closed
lars-t-hansen opened this issue Mar 29, 2016 · 6 comments
Closed

Integrate spec text into ES text with change bars? #92

lars-t-hansen opened this issue Mar 29, 2016 · 6 comments
Milestone

Comments

@lars-t-hansen
Copy link
Collaborator

In Issue #77 @waldemarhorwat writes:

Is there a way to see the integrated proposal as an ES6 document with change bars? I'm having a hard time with the mechanics of reading the proposal as only a delta, and it's very difficult to tell if something more should be included but is missing.

@domenic @bterlson Does ecmarkup have that kind of functionality?

@lars-t-hansen
Copy link
Collaborator Author

Domenic says "use INS and DEL tags".

@lars-t-hansen
Copy link
Collaborator Author

@waldemarhorwat, how does this version look to you?

@littledan, would it be appropriate to offer the proposal to the committee in this form? I sure would prefer not to have to maintain two sets of proposal text.

@littledan
Copy link
Member

So far, seems like most proposals have proceeded with just an external document, not a diff/PR against the main spec. SharedArrayBuffer has mostly been developed in this form, and I think it's good. ins and del tags are useful when modifying existing internal algorithms or grammar, but I don't know if SAB runs into any of those. The work of integrating directly into the main spec text tends to be done some time after Stage 3. I don't think you need to maintain the PR against the spec--that sounds like a lot of work with all the rebasing.

@bterlson
Copy link
Member

Please do not maintain a PR against the spec. Once your spec is stage 4 (or when you're pushing for stage 4) is the appropriate time for producing the spec PR.

@lars-t-hansen
Copy link
Collaborator Author

OK, fair enough. I'll consider the matter closed until the proposal advances.

@lars-t-hansen
Copy link
Collaborator Author

As a compromise (and because I think it is an improvement) I have -- in selected cases, notably several altered algorithms -- copied a small amount of text from ES262 into the shared memory draft spec and marked the diff from ES262 using INS/DEL tags. I have also identified the base revision of ES262 for that. As it was, the spec was out of sync with current ES262 and was hard to understand.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants