{"action":"created","issue":{"url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/65","labels_url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/65/labels{/name}","comments_url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/65/comments","events_url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/65/events","html_url":"https://github.com/probcomp/bdbcontrib/issues/65","id":110464893,"number":65,"title":"Distinguish public from internal functions in generated per-module documentation","user":{"login":"axch","id":233710,"avatar_url":"https://avatars.githubusercontent.com/u/233710?v=3","gravatar_id":"","url":"https://api.github.com/users/axch","html_url":"https://github.com/axch","followers_url":"https://api.github.com/users/axch/followers","following_url":"https://api.github.com/users/axch/following{/other_user}","gists_url":"https://api.github.com/users/axch/gists{/gist_id}","starred_url":"https://api.github.com/users/axch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axch/subscriptions","organizations_url":"https://api.github.com/users/axch/orgs","repos_url":"https://api.github.com/users/axch/repos","events_url":"https://api.github.com/users/axch/events{/privacy}","received_events_url":"https://api.github.com/users/axch/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/probcomp/bdbcontrib/milestones/3","html_url":"https://github.com/probcomp/bdbcontrib/milestones/R5","labels_url":"https://api.github.com/repos/probcomp/bdbcontrib/milestones/3/labels","id":1341254,"number":3,"title":"R5","description":"","creator":{"login":"axch","id":233710,"avatar_url":"https://avatars.githubusercontent.com/u/233710?v=3","gravatar_id":"","url":"https://api.github.com/users/axch","html_url":"https://github.com/axch","followers_url":"https://api.github.com/users/axch/followers","following_url":"https://api.github.com/users/axch/following{/other_user}","gists_url":"https://api.github.com/users/axch/gists{/gist_id}","starred_url":"https://api.github.com/users/axch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axch/subscriptions","organizations_url":"https://api.github.com/users/axch/orgs","repos_url":"https://api.github.com/users/axch/repos","events_url":"https://api.github.com/users/axch/events{/privacy}","received_events_url":"https://api.github.com/users/axch/received_events","type":"User","site_admin":false},"open_issues":3,"closed_issues":0,"state":"open","created_at":"2015-10-06T20:11:26Z","updated_at":"2015-10-08T14:33:36Z","due_on":"2015-10-20T04:00:00Z","closed_at":null},"comments":3,"created_at":"2015-10-08T14:33:36Z","updated_at":"2015-10-08T21:49:26Z","closed_at":null,"body":"I imagine that Sphinx's automodule honors the prefix underscore convention; failing that, could use autofunction instead to cherry pick documented functions.\r\n\r\nWhat is our bdbcontrib documentation strategy in general?"},"comment":{"url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/comments/146695421","html_url":"https://github.com/probcomp/bdbcontrib/issues/65#issuecomment-146695421","issue_url":"https://api.github.com/repos/probcomp/bdbcontrib/issues/65","id":146695421,"user":{"login":"axch","id":233710,"avatar_url":"https://avatars.githubusercontent.com/u/233710?v=3","gravatar_id":"","url":"https://api.github.com/users/axch","html_url":"https://github.com/axch","followers_url":"https://api.github.com/users/axch/followers","following_url":"https://api.github.com/users/axch/following{/other_user}","gists_url":"https://api.github.com/users/axch/gists{/gist_id}","starred_url":"https://api.github.com/users/axch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/axch/subscriptions","organizations_url":"https://api.github.com/users/axch/orgs","repos_url":"https://api.github.com/users/axch/repos","events_url":"https://api.github.com/users/axch/events{/privacy}","received_events_url":"https://api.github.com/users/axch/received_events","type":"User","site_admin":false},"created_at":"2015-10-08T21:49:26Z","updated_at":"2015-10-08T21:49:26Z","body":"bdbcontrib is currently arranged into per-topic modules with public interfaces and (often substantial) piles of supporting functions.  It would be possible to rename all the existing topic modules calling them internal, and create small facade modules that import only the public functions from the internal ones.  I don't know whether the Python community has a strong \"internal module\" convention; following the strong \"internal function\" convention seems more socially consistent; but I am not committed to either style.\r\n\r\nPerhaps a variant of this would be to split bdbcontrib into per-topic packages.  Then the init files of those packages would serve as the facade modules.  Thoughts?"}}