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

Subcollections should be documented #44

Closed
jackfirth opened this issue Jul 6, 2015 · 3 comments
Closed

Subcollections should be documented #44

jackfirth opened this issue Jul 6, 2015 · 3 comments

Comments

@jackfirth
Copy link
Owner

Currently the relevant subcollections are:

  • lens/base
  • lens/list
  • lens/hash
  • lens/syntax
  • lens/struct
  • lens/applicable (re-exports lens)

Note that once documented, changing the names or paths of subcollections is a breaking change. Therefore, prefer not to expose subcollections unless they are of significant size.

@jackfirth
Copy link
Owner Author

For 1.0, it's only necessary that the two modules lens and lens/applicable be documented. All other subcollections should be undocumented so as not to commit to something that may later change. lens/base may be an exception to this, though it's not strictly necessary for 1.0

@jackfirth jackfirth added the api label Jul 8, 2015
@jackfirth jackfirth removed this from the 1.0 milestone Jul 8, 2015
@jackfirth
Copy link
Owner Author

Moving into backlog as it no longer blocks 1.0

@jackfirth
Copy link
Owner Author

Closing in favor of issues for specific subcollections, e.g. #108

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant