{"action":"created","issue":{"url":"https://api.github.com/repos/jackfirth/lens/issues/44","labels_url":"https://api.github.com/repos/jackfirth/lens/issues/44/labels{/name}","comments_url":"https://api.github.com/repos/jackfirth/lens/issues/44/comments","events_url":"https://api.github.com/repos/jackfirth/lens/issues/44/events","html_url":"https://github.com/jackfirth/lens/issues/44","id":93336651,"number":44,"title":"Subcollections should be documented","user":{"login":"jackfirth","id":8175575,"avatar_url":"https://avatars.githubusercontent.com/u/8175575?v=3","gravatar_id":"","url":"https://api.github.com/users/jackfirth","html_url":"https://github.com/jackfirth","followers_url":"https://api.github.com/users/jackfirth/followers","following_url":"https://api.github.com/users/jackfirth/following{/other_user}","gists_url":"https://api.github.com/users/jackfirth/gists{/gist_id}","starred_url":"https://api.github.com/users/jackfirth/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jackfirth/subscriptions","organizations_url":"https://api.github.com/users/jackfirth/orgs","repos_url":"https://api.github.com/users/jackfirth/repos","events_url":"https://api.github.com/users/jackfirth/events{/privacy}","received_events_url":"https://api.github.com/users/jackfirth/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/jackfirth/lens/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/jackfirth/lens/labels/needs%20discussion","name":"needs discussion","color":"ededed"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/jackfirth/lens/milestones/1","html_url":"https://github.com/jackfirth/lens/milestones/1.0","labels_url":"https://api.github.com/repos/jackfirth/lens/milestones/1/labels","id":1195833,"number":1,"title":"1.0","description":"When reached, the package should be available with version 1.0 and all further releases should be backwards compatible.","creator":{"login":"jackfirth","id":8175575,"avatar_url":"https://avatars.githubusercontent.com/u/8175575?v=3","gravatar_id":"","url":"https://api.github.com/users/jackfirth","html_url":"https://github.com/jackfirth","followers_url":"https://api.github.com/users/jackfirth/followers","following_url":"https://api.github.com/users/jackfirth/following{/other_user}","gists_url":"https://api.github.com/users/jackfirth/gists{/gist_id}","starred_url":"https://api.github.com/users/jackfirth/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jackfirth/subscriptions","organizations_url":"https://api.github.com/users/jackfirth/orgs","repos_url":"https://api.github.com/users/jackfirth/repos","events_url":"https://api.github.com/users/jackfirth/events{/privacy}","received_events_url":"https://api.github.com/users/jackfirth/received_events","type":"User","site_admin":false},"open_issues":4,"closed_issues":11,"state":"open","created_at":"2015-07-06T22:33:59Z","updated_at":"2015-07-08T05:36:08Z","due_on":null,"closed_at":null},"comments":1,"created_at":"2015-07-06T17:51:48Z","updated_at":"2015-07-08T05:40:28Z","closed_at":null,"body":"Currently the relevant subcollections are:\r\n\r\n* `lens/core` (should be named `lens/base`, see #45)\r\n* `lens/list`\r\n* `lens/hash`\r\n* `lens/syntax`\r\n* `lens/struct-lens` (should be named `lens/struct` in keeping with the style of the other collections, see #46)\r\n* `lens/applicable` (re-exports `lens`)\r\n\r\nNote 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."},"comment":{"url":"https://api.github.com/repos/jackfirth/lens/issues/comments/119443503","html_url":"https://github.com/jackfirth/lens/issues/44#issuecomment-119443503","issue_url":"https://api.github.com/repos/jackfirth/lens/issues/44","id":119443503,"user":{"login":"jackfirth","id":8175575,"avatar_url":"https://avatars.githubusercontent.com/u/8175575?v=3","gravatar_id":"","url":"https://api.github.com/users/jackfirth","html_url":"https://github.com/jackfirth","followers_url":"https://api.github.com/users/jackfirth/followers","following_url":"https://api.github.com/users/jackfirth/following{/other_user}","gists_url":"https://api.github.com/users/jackfirth/gists{/gist_id}","starred_url":"https://api.github.com/users/jackfirth/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jackfirth/subscriptions","organizations_url":"https://api.github.com/users/jackfirth/orgs","repos_url":"https://api.github.com/users/jackfirth/repos","events_url":"https://api.github.com/users/jackfirth/events{/privacy}","received_events_url":"https://api.github.com/users/jackfirth/received_events","type":"User","site_admin":false},"created_at":"2015-07-08T05:40:28Z","updated_at":"2015-07-08T05:40:28Z","body":"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"}}