Skip to content

Provide flexible way to update TypeScript specification #13870

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

Closed
ikokostya opened this issue Feb 3, 2017 · 2 comments
Closed

Provide flexible way to update TypeScript specification #13870

ikokostya opened this issue Feb 3, 2017 · 2 comments
Labels
Spec Issues related to the TypeScript language specification

Comments

@ikokostya
Copy link
Contributor

ikokostya commented Feb 3, 2017

TypeScript Version: 2.1.5

Problem

Current specification doesn't describe some features from latest stable version of compiler, e.g. null is not assignable to void #11758

Specification can't be easy changed, because is first authored as a Microsoft Word (docx) file https://github.com/Microsoft/TypeScript/tree/master/doc#spec-contributions:

  • It's closed format and requires special editors.
  • It's binary format and doesn't allow see changes between versions.

Suggestion

  • Use markdown as source format for specification.
    Pros:
  • Generate other formats from markdown.
@mhegazy mhegazy added the Spec Issues related to the TypeScript language specification label Feb 3, 2017
@simonbuchan
Copy link

There is already a markdown version: https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md - is it not suitable as a source for some reason? Copy editors? Validation?

The source is mostly very clean and idiomatic markdown, the only real grossness I've seen in there is the grammar using &emsp;, which seems like it could use <pre> and regular spaces (&emsp; is ~ 2 spaces?)

It would be nice if it could get into a state good enough that PRs that would affect the spec must also update spec.md before merging - would maintaining this as multiple issues update be a burden? (twice the change conflicts)

Should it be broken up into spec_4_statements.md etc?

Would PRs against it as it currently is be accepted? I'm no spec writer, but I could definitely try to go through the release blogs and offer strawman updates.

@RyanCavanaugh
Copy link
Member

The spec is now an "archived" artifact and we won't be tracking defects against it anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Spec Issues related to the TypeScript language specification
Projects
None yet
Development

No branches or pull requests

4 participants