fun icon indicating copy to clipboard operation
fun copied to clipboard

NonEmptyArray - Post 2.0

Open baetheus opened this issue 3 years ago • 1 comments
trafficstars

Standard Module Implementation for nonempty_array.ts

  • [ ] Add file block comment at top of file describing the adt/structure.
  • [ ] Check for any missing combinators/derivations that could be implemented.
  • [ ] Modify all combinator variable names to be readable (use style guide).
  • [ ] Add documentation to every export (and // comment local tools).
  • [ ] Check that every function and line is covered by tests in the testing directory.

Style Guide

  • Use A -> I, B -> J, C -> K, D -> L for inner types.
  • Use ua, va to match URI, VRI, etc in generic positions.
  • Implement algebraic structure types (type classes) out to length 4.
  • Use functions over const arrow functions for root exports.
  • Document all type exports.
  • Order file exports by group and then alphabetically. Groups are Types, Constructors, Combinators, Type Class Instances, Type Class Constructors, and Derived Combinators.

Documentation Guide

  • Start with at least one full sentence describing the use case for the export.
  • Include a @since tag (default to 2.0.0)
  • Include an @example tag with a simple example
    • Imports should be relative for functional stuff and otherwise full urls with versions
    • Example should end with at least one assert from the deno std lib

baetheus avatar Sep 17 '22 16:09 baetheus

For now I think this might remain as a type and a refinement in array.ts

baetheus avatar Oct 02 '22 16:10 baetheus