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

Documentation/website: Single page cheatsheet #253

Open
Raynos opened this issue May 24, 2020 · 1 comment
Open

Documentation/website: Single page cheatsheet #253

Raynos opened this issue May 24, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@Raynos
Copy link
Contributor

Raynos commented May 24, 2020

The type system for python has a nice cheatsheet ( https://mypy.readthedocs.io/en/latest/cheat_sheet.html ).

I've copied this in the past ( https://github.com/Raynos/jsig/blob/master/docs/cheatsheet.md ).

Such a cheatsheet is a great feature for the website

  • Shows a list of types available
  • Shows the behavior of type inference with no annotations
  • Shows examples of adding type annotations
  • Shows examples of refinement
  • Shows example of casting syntax
  • Shows examples of debugging ( reveal_type / typeof x;
  • Shows examples of common places where a type annotation is needed and a user might "expect" inference to just work, e.g. const x = [] etc

It's an easy to share link that gives a quick refresher on how to use Hegel.

@JSMonk
Copy link
Owner

JSMonk commented May 24, 2020

Oh, nice. I will add it to Hegel. Thank you a lot for the suggestion ^_^

@JSMonk JSMonk added the enhancement New feature or request label May 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants