Documentations Issues Continued: can-define/map/map

[indifferentghost]

This is a continuation of issue #362 separated for can-define/map/map. It was separated to provide amiable and more accurate estimates.

can-define/map/map.html

• codepen-able
• import changed to can
• @can.onInstancePatches misspelling isntance -> instance.
• Resonable examples for Asynchronous getters

map/KeysEvent.html

Needs:

• codepen
• ES6
• Syntax Highlighting
• Use section

Discourse:

• It's difficult to rationalize what this is for, I'm not sure if this article is a stub or should be tightly linked to something else.

map/PropertyNameEvent.html

Needs:

• codepen
• ES6
• Syntax Highlighting
• Use section

map/map.extend.html

• Update to "can" import
• Add working examples.

Discourse:

• The examples should probably be moved into separate signatures with further elaboration.

map/map.seal.html

Needs:

• codepen

Discourse:

• Does this need a use section? The boolean section seems fairly descriptive.

map/map.prototype.assign.html

Needs:

• codepen
• ES6

Discourse:

• Article is a stub, and doesn't include a Use section. map.assign(props) is fairly descriptive.

map/map.prototype.assignDeep.html

Needs:

• codepen
• ES6
• example actually returns ["first", "2", "3"].

map/map.prototype.deleteKey.html

Needs:

• codepen
• ES6
• Better elaboration that it doesn't delete the keys predefined by type because it would also have to delete those getter and setters on other instances.

Discourse:

• Article is a stub, and doesn't include a Use section.

map/map.prototype.forEach.html

Needs:

• codepen
• ES6
• Syntax Highlighting

Discourse:

• While this has a Use section it should probably elaborate further what the example is actually doing.

map/map.prototype.get.html

Needs:

• codepen
• ES6

Discourse:

• map.get(propName) should probably have an example that doesn't include undefined. Might be good to have a verbose example for get and in comparison of how it returns values.

const todo = new DefineMap({ name: 'example', complete: false });
console.log(todo['name'] === todo.get('name')); // true

map/map.prototype.serialize.html

Needs:

• codepen
• ES6

Discourse:

• Further elaboration of the differentiations between map.prototype.get and map.prototype.serialize.html.

map/map.prototype.set.html

Needs:

• Examples

Discourse:

.get(propName) only should be used when reading properties that might not have been defined yet, but will be later via [can-define/map/map.prototype.set].

• There should be some elaboration on when to use get vs bracket/dot notation. I've been told the above is incorrect.

map/map.prototype.update.html

Needs:

• codepen
• ES6

map/map.prototype.updateDeep.html

Needs:

• codepen
• ES6

map/map.prototype.wildcard.html

Needs:

• Syntax Highlighting
• ES6
• codepen
• reasonable examples for wildcard.

Discourse:

• It might be worth it to have a verbose use section for all wildcard.