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

initial type system documentation #914

Merged
merged 4 commits into from
Nov 17, 2020
Merged

initial type system documentation #914

merged 4 commits into from
Nov 17, 2020

Conversation

majastrz
Copy link
Member

Initial docs for the type system. This fixes #36.

@codecov-io
Copy link

codecov-io commented Nov 14, 2020

Codecov Report

Merging #914 (9cd19d4) into main (471dd5f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #914   +/-   ##
=======================================
  Coverage   94.55%   94.55%           
=======================================
  Files         302      302           
  Lines       13682    13682           
  Branches       12       12           
=======================================
  Hits        12937    12937           
  Misses        745      745           
Flag Coverage Δ
dotnet 95.20% <ø> (ø)
typescript 25.78% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@anthony-c-martin
Copy link
Member

Looks good! Now that we have type checking on the scope property, I think it would be worth mentioning this (see ResourceScopeReference & IResourceScopeType in the code).

| `any` | The value can be anything or allows anything. |
| `error` | The expression has an error. |
| `string` | Represents arbitrary text. Equivalent to JSON strings. |
| `number` | **Not yet implemented (#486)** Represents a floating point number or a big integer. Equivalent to the JSON
Copy link
Collaborator

Choose a reason for hiding this comment

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

GitHub doesn't make the # a link in docs like this. Can you add the link manually?

Copy link
Member Author

Choose a reason for hiding this comment

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

Didn't realize that. Will fix...

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed

@majastrz
Copy link
Member Author

Looks good! Now that we have type checking on the scope property, I think it would be worth mentioning this (see ResourceScopeReference & IResourceScopeType in the code).

Pushed out an update for this. Let me know if that works...

Copy link
Member

@anthony-c-martin anthony-c-martin left a comment

Choose a reason for hiding this comment

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

Looks great!

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.

Type system
4 participants