Skip to content
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.

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

Functor 2.0 #87

Closed
5 tasks
baetheus opened this issue Sep 3, 2022 · 0 comments
Closed
5 tasks

Functor 2.0 #87

baetheus opened this issue Sep 3, 2022 · 0 comments
Milestone

Comments

@baetheus
Copy link
Owner

baetheus commented Sep 3, 2022

Standard Module Implementation for functor.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 baetheus added this to the 2.0 milestone Sep 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant