can-query-logic documentation

[indifferentghost]

can-query-logic.html

• [x] ES6
• [ ] codepen
  • [x] maybe-number example doesn't work due to issue canjs/can-data-types/issues/7.
  • [ ] BasicQuery is not an export from the can repository
  • [ ] Update toParams, toQuery examples.
• [ ] add context to Testing your QueryLogic.
• [x] indentation

can-query-logic.prototype.count.html

• [x] ES6
• [x] codepen
• [x] indentation
• [ ] article is a stub
• [ ] Link to MDN for [Infinity](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity)?

can-query-logic.prototype.difference.html

• [x] ES6
• [x] codepen
• [x] indentation
• [ ] article is a stub

can-query-logic.prototype.filterMembersAndGetCount.html

• [x] ES6
• [x] codepen
• [x] indentation
• [ ] article is a stub

can-query-logic.prototype.filterMembers.html

• [x] codepen
• [x] indentation
• [ ] article should have a more thorough explanation when super set is required.
• [ ] Mention pagination and sorting and how it's used with filterMembers.

can-query-logic.prototype.identityKeys.html

• [x] codepen
• [x] ES6
• [x] indentation
• [ ] I'm curious if there's any quirks or edge cases that identityKeys has.

can-query-logic.prototype.index.html

• [x] codepen
• [x] indentation
• [x] Added example if no sort option is given.
• [ ] Add required to the params. Most other methods see if the given data structures are correct.
• [ ] Since object key order is unreliable is it reliable to not provide a key to sort by?

can-query-logic.prototype.intersection.html

• [x] codepen
• [x] indentation

can-query-logic.prototype.isDefinedAndHasMembers.html

• [x] codepen
• [x] ES6
• [x] indentation
• [x] in examples the query object is returned if it is not a special object (that is not UNIVERSAL). Update documentation to reflect such.

can-query-logic.prototype.isEqual.html

• [x] codepen
• [x] indentation

can-query-logic.prototype.isMember.html

• [x] codepen
• [x] indentation

can-query-logic.prototype.isProperSubset.html

• [x] codepen
• [x] indentation
• [ ] article is a stub, should have better example showing an example set and subset.

can-query-logic.prototype.isSpecial.html

• [x] codepen
• [x] indentation
• [x] ES6
• [x] example should use .isSpecial and not .isDefinedAndHasMembers.
• [x] changed example results and documentation as this does return true if the object is UNIVERSAL, EMPTY, UNDEFINABLE, or UNKNOWABLE.

can-query-logic.prototype.isSubset.html

• [x] codepen
• [x] indentation
• [ ] should provide example where .isSubset is not true.

can-query-logic.prototype.memberIdentity

• [ ] is hidden using @hide tag
• [x] ES6
• [x] codepen
• [x] indentation

can-query-logic.prototype.unionMembers.html

• [x] codepen
• [x] indentation

can-query-logic.prototype.union.html

• [x] codepen
  • [x] codepen only logs up to a certain nesting added JSON.stringify around return value to show full object.
• [x] indentation

can-query-logic/comparison-operators.html

• [x] Fixed spelling mistake under $ne signature. $eq -> $ne.
• [x] Add example for each operator.

Discourse:

• [ ] The folder [/operators](https://github.com/canjs/can-query-logic/tree/master/doc/operators) can probably be removed unless the eventual idea is to separate can-query-logic/comparison-operators.html.
• [x] Do the signatures need examples?

can-query-logic/query.html

• [ ] codepen
• [ ] indentation

can-query-logic.EMPTY.html

• [ ] needs example
• [ ] Article is a stub.

can-query-logic.KeysAnd.html

• [ ] Article under doc/static/AndKeys.md it should probably be renamed to KeysAnd.md to match other references.
• [x] ES6
• [x] Codepenable
• [x] linked references to static-methods/set[...]

can-query-logic.UNDEFINABLE.html

• [x] ES6
• [x] Codepenable
• [x] commented out fragment

  Use UNKNOWABLE to represent

Discourse:

• [ ] An example on the article references QueryLogic.Not which isn't an operator. There's currently no @codepen tag on the example to prevent confusion. It might be worth while to remove this example.

can-query-logic.UNIVERSAL.html

• [ ] Article needs an example.
• [ ] Article is a stub.

can-query-logic.UNKNOWABLE.html

• [ ] codepen
  • [ ] get alternatives example working
• [x] indentation

can-query-logic.set.difference.html

• [x] codepen
• [x] ES6
• [x] indentation

  discourse:

• [ ] QueryLogic.set.difference seems to be QueryLogic.difference should this be changed?

can-query-logic.set.intersection.html

• [x] codepen
• [x] es6
• [x] indentation

  discourse:

• [ ] QueryLogic.set.intersection seems to be QueryLogic.intersection should this be changed in all documentation?

can-query-logic.set.union.html

• [x] codepen
• [x] es6
• [x] indentation

  discourse:

• [ ] QueryLogic.set.union seems to be QueryLogic.union should this be changed in all documentation? This could be confused with QueryLogic.prototype.union is there a good way to separate these?

doc/value-types

Discourse:

• [ ] value types is a folder with empty files, is this meant to continue to expand on various QueryLogic value types ( ex: QueryLogic.GreaterThan ) or should this folder be removed?

doc/etc

• [x] ES6
• [x] codepen
• [ ] doesn't match formatting of other documents

  discourse:

• [x] This file doesn't appear on main the main document page and should either be removed or updated to fit similar formatting.

can-query-logic.defineComparison.html

• [ ] codepen
  • [ ] GreaterThan, LessThan, etc. are not global constants from the can framework, they do seem to be functions on the QueryLogic.
  • [x] Updated Use to reference examples/recipe-example.js
• [x] indentation

[justinbmeyer]

I think you might have forgotten about can-query-logic.defineComparison.html

[justinbmeyer]

etc should be removed. Looks like you removed it: https://github.com/canjs/can-query-logic/pull/18/files#diff-0a90908bb7e02eebae809eb72a9c5207