Skip to content

Support for enumeration types #373

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.

Sign up for GitHub

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

Jump to bottom
Closed
jfirebaugh opened this issue Mar 13, 2016 · 4 comments
Closed

Support for enumeration types #373

jfirebaugh opened this issue Mar 13, 2016 · 4 comments
Assignees
@arv
Labels
jsdoc-extension

Comments

@jfirebaugh
Copy link
Member 

/**
 * @param {('rect'|'circle'|'ellipse')} shapeType - The allowed type of the shape
 */

References:

This is necessary for #18 to document such things as the valid values for @kind.
@jfirebaugh
Copy link
Member Author

Currently behavior is to fail lint:

        1:1  warning  unexpected token

@jfirebaugh jfirebaugh mentioned this issue Mar 20, 2016
Closed
@jfirebaugh
Copy link
Member Author

Upstream: eslint/doctrine#156

@jfirebaugh
Copy link
Member Author

Support landed upstream; this should be unblocked now -- or perhaps even just work?

@arv arv self-assigned this Sep 3, 2016
arv added a commit to arv/documentation that referenced this issue Sep 3, 2016
@arv
Cleanup enumeration types
92e4d05 
This updates Doctrine to 1.3 to pick up its support for literal types
(doctrine still does not support boolean literals types).

Towards documentationjs#373
arv added a commit to arv/documentation that referenced this issue Sep 3, 2016
@arv
Cleanup literal types
d0c6f37 
This updates Doctrine to 1.3 to pick up its support for literal types
(doctrine still does not support boolean literals types).

Towards documentationjs#373
@arv arv mentioned this issue Sep 3, 2016
Merged
arv added a commit to arv/documentation that referenced this issue Sep 3, 2016
@arv
Cleanup literal types
6d90c79 
This updates Doctrine to 1.3 to pick up its support for literal types
(doctrine still does not support boolean literals types).

Towards documentationjs#373
tmcw pushed a commit that referenced this issue Sep 4, 2016
@arv @tmcw
Cleanup literal types (#522)
895775d 
This updates Doctrine to 1.3 to pick up its support for literal types
(doctrine still does not support boolean literals types).

Towards #373
@tmcw
Copy link
Member

tmcw commented Apr 12, 2017

This is the same issue as #662 and is also covered by the new tests in #721

@tmcw tmcw closed this as completed Apr 12, 2017
rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
@thomashoneyman @JordanMartinez
@kl0tl @hdgarrood
Add PureScript 0.14 migration guide (documentationjs#373)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode
263a1bc 
* Add PureScript 0.14 migration guide

* Add more bifunctor newtypes ported to functors

* Fix small typo in `fromLeft'` example

* Fix typo: use diff syntax highlighter

* Apply suggestions from code review

Co-authored-by: Cyril <[email protected]>

* Apply suggestions from code review

Co-authored-by: Cyril <[email protected]>

* Update ecosystem/purescript-0.14-migration-guide.md

Co-authored-by: Harry Garrood <[email protected]>

* 0.13.x: `a` in `Proxy a` defaults to kind, `Type`

* Note module naming convention for Generic

* Clarify 'this' to mean Proxy type

* Address PR feedback

* Rename ecosystem/purescript-0.14-migration-guide.md to ecosystem/migration-guides/0.14-Migration-Guide.md

* Rename ecosystem/migration-guides/0.14-Migration-Guide.md to migration-guides/0.14-Migration-Guide.md

* Don't mention the deprecated TypeInType Haskell extension

* Fix link to the roles documentation

* Add missing import in examples

* Apply suggestions from code review

Co-authored-by: Harry Garrood <[email protected]>

* Update 0.14-Migration-Guide.md

* Update 0.14-Migration-Guide.md

Co-authored-by: JordanMartinez <[email protected]>
Co-authored-by: Cyril <[email protected]>
Co-authored-by: Harry Garrood <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arv arv

Labels
jsdoc-extension
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tmcw @arv @jfirebaugh