dx-spec
dx-spec copied to clipboard
tmcw
Which tags to take from JSDoc?
Here's a list of all the existing JSDoc tags which we could consider adding. I've checked off the ones I think are reasonable to consider
- [ ]
@abstract(synonyms:@virtual): This member must be implemented (or overridden) by the inheritor. - [ ]
@access: Specify the access level of this member (private, package-private, public, or protected). - [ ]
@alias: Treat a member as if it had a different name. - [ ]
@async: Indicate that a function is asynchronous. - [ ]
@augments(synonyms:@extends): Indicate that a symbol inherits from, and adds to, a parent symbol. - [x]
@author: Identify the author of an item. - [ ]
@borrows: This object uses something from another object. - [ ]
@callback: Document a callback function. - [ ]
@class(synonyms:@constructor): This function is intended to be called with the "new" keyword. - [ ]
@classdesc: Use the following text to describe the entire class. - [ ]
@constant(synonyms:@const): Document an object as a constant. - [ ]
@constructs: This function member will be the constructor for the previous class. - [x]
@copyright: Document some copyright information. - [ ]
@default(synonyms:@defaultvalue): Document the default value. - [x]
@deprecated: Document that this is no longer the preferred way. - [ ]
@description(synonyms:@desc): Describe a symbol. - [ ]
@enum: Document a collection of related properties. - [x]
@event: Document an event. - [ ]
@example: Provide an example of how to use a documented item. - [ ]
@exports: Identify the member that is exported by a JavaScript module. - [ ]
@external(synonyms:@host): Identifies an external class, namespace, or module. - [ ]
@file(synonyms:@fileoverview, @overview): Describe a file. - [x]
@fires(synonyms:@emits): Describe the events this method may fire. - [ ]
@function(synonyms:@func, @method): Describe a function or method. - [ ]
@generator: Indicate that a function is a generator function. - [ ]
@global: Document a global object. - [ ]
@hideconstructor: Indicate that the constructor should not be displayed. - [x]
@ignore: Omit a symbol from the documentation. - [x]
@implements: This symbol implements an interface. - [ ]
@inheritdoc: Indicate that a symbol should inherit its parent's documentation. - [ ]
@inner: Document an inner object. - [ ]
@instance: Document an instance member. - [ ]
@interface: This symbol is an interface that others can implement. - [ ]
@kind: What kind of symbol is this? - [ ]
@lends: Document properties on an object literal as if they belonged to a symbol with a given name. - [x]
@license: Identify the license that applies to this code. - [ ]
@listens: List the events that a symbol listens for. - [ ]
@member(synonyms:@var): Document a member. - [ ]
@memberof: This symbol belongs to a parent symbol. - [ ]
@mixes: This object mixes in all the members from another object. - [ ]
@mixin: Document a mixin object. - [ ]
@module: Document a JavaScript module. - [ ]
@name: Document the name of an object. - [ ]
@namespace: Document a namespace object. - [ ]
@override: Indicate that a symbol overrides its parent. - [ ]
@package: This symbol is meant to be package-private. - [x]
@param(synonyms:@arg, @argument): Document the parameter to a function. - [ ]
@private: This symbol is meant to be private. - [ ]
@property(synonyms:@prop): Document a property of an object. - [ ]
@protected: This symbol is meant to be protected. - [ ]
@public: This symbol is meant to be public. - [x]
@readonly: This symbol is meant to be read-only. - [ ]
@requires: This file requires a JavaScript module. - [x]
@returns(synonyms:@return): Document the return value of a function. - [x]
@see: Refer to some other documentation for more information. - [x]
@since: When was this feature added? - [ ]
@static: Document a static member. - [x]
@summary: A shorter version of the full description. - [x]
@this: What does the 'this' keyword refer to here? - [x]
@throws(synonyms:@exception): Describe what errors could be thrown. - [x]
@todo: Document tasks to be completed. - [x]
@tutorial: Insert a link to an included tutorial file. - [ ]
@type: Document the type of an object. - [ ]
@typedef: Document a custom type. - [ ]
@variation: Distinguish different objects with the same name. - [x]
@version: Documents the version number of an item. - [x]
@yields(synonyms:@yield): Document the value yielded by a generator function.
opendrinks has 370 recipes that are structured, but pretty inconsistent in formatting. https://github.com/alfg/opendrinks
In the meantime, I've been mostly pulling from Wikipedia, which in turn pulls from the 'official' IBA list.
Reviewing wikipedia and some popular ones that aren't there yet:
- https://en.wikipedia.org/wiki/Margarita
- https://en.wikipedia.org/wiki/White_Russian_(cocktail)
- https://en.wikipedia.org/wiki/Gimlet_(cocktail)
- https://en.wikipedia.org/wiki/Mint_julep
- https://en.wikipedia.org/wiki/Tequila_Sunrise_(cocktail)
- https://en.wikipedia.org/wiki/Paloma_(cocktail)
- https://en.wikipedia.org/wiki/Greyhound_(cocktail)
Any reason why you’re not pulling from the “official” IBA directly? It has relatively structured data: https://iba-world.com/new-era-drinks/
Nope, that'd be a good idea! It'll require a scrape pass & then moderate intelligent parsing for ingredients and and types of glasses to fit the data model.
OK, scraped unforgettables and new era’s, but https://iba-world.com/contemporary-classics/ is an entirely different format 😭
Alright well that took longer than expected. Walked through all existing, and added all others from iba. Now to add icons for new glasses. Expect them tonight or tomorrow!
Thanks to @wooorm the list is now expansive and awesome!
There are some drinks that are not iba-certified but still commonplace that we can still add - this afternoon might dig up the 'tonic' (g&t, vodka tonic, etc) family
Realizing that we're pretty low on tiki drinks! Via gastropod's tiki time episode, via leanne, there's Jeff Berry who decoded a lot of them and has classy nice versions.