typed-objects-es7 icon indicating copy to clipboard operation
typed-objects-es7 copied to clipboard

Demonstrate informal examples somewhere.

Open Raynos opened this issue 11 years ago • 10 comments

It would be useful for people that are not familiar with specifications to see informal examples of typed objects to get a reasonable understanding of what they and what problem domain they solve.

Raynos avatar Apr 10 '14 16:04 Raynos

We have informal introduction here: http://wiki.ecmascript.org/doku.php?id=harmony:typed_objects. Does it fit the bill?

dslomov avatar Apr 10 '14 17:04 dslomov

Is it up to date? Anything on the wiki makes me automatically suspicious :).

In any case it should ideally be moved here to an Explainer.md or similar.

domenic avatar Apr 10 '14 17:04 domenic

Yes, I try to keep it up-to-date. We need to have something on a wiki, so I prefer the wiki to be an explainer and this be the spec.

dslomov avatar Apr 10 '14 17:04 dslomov

IMO the wiki is a lost cause and nobody trusts it anymore. But if you want to try to save its reputation then up to you. shrug

domenic avatar Apr 10 '14 17:04 domenic

In that case add a "for informal ex platoon see wiki (link)" section to the readme :)

Raynos avatar Apr 10 '14 17:04 Raynos

I'd prefer to not use the wiki at all as it has no credibility...

I am hoping @wycats's guidelines for ECMAScript proposals will have a template that includes adding motivating use cases to Readme.md. Does that seem problematic?

bterlson avatar Apr 10 '14 18:04 bterlson

No it does not. If that is what we all do, I'll move it here (in this repo, Readme.md is the spec itself, but that is easily changable)

dslomov avatar Apr 10 '14 18:04 dslomov

This might not be the best place to discuss the finer points of @wycats's proposal proposal but IMO the readme-as-spec works really well and a separate Explainer.md helps keep things separate.

domenic avatar Apr 10 '14 18:04 domenic

Yes, good point Domenic, the correct place to discuss this is here: https://github.com/tc39/ecma262/issues/3. (I like your proposal, though!)

bterlson avatar Apr 10 '14 19:04 bterlson

Thanks Dmitry @dslomov.

Wiki is down. Those that need an example, see http://smallcultfollowing.com/babysteps/pubs/2014.04.01-TypedObjects.pdf and https://github.com/dslomov/structs.js.

peter-lyons-kehl avatar Jan 03 '18 03:01 peter-lyons-kehl