{"action":"created","comment":{"url":"https://api.github.com/repos/JuliaLang/julia/pulls/comments/37470796","id":37470796,"diff_hunk":"@@ -236,7 +236,29 @@ Namespace miscellanea\n ---------------------\n \n If a name is qualified (e.g. ``Base.sin``), then it can be accessed even if\n-it is not exported. This is often useful when debugging.\n+it is not exported. This is often useful when debugging. Normally Julia\n+variables, functions, types, and the fields of composite types are publicly\n+accessible. Julia does not have corresponding \"private\" versions of these\n+items that are inaccessible from outside the module. However, a common\n+Julia convention is that names prefixed with an underscore (e.g.,\n+``_foo()``) are private implementation details.\n+\n+Exported names form the public facing API of a module. In some cases,\n+unexported names are also part of the public API, such as found in the\n+``Pkg`` and ``Profile`` modules in Base. In these cases, the unexported\n+names should be clearly documented. Changes to public APIs should be made\n+with care. Registered packages should bump their version number\n+appropriately to signal the breaking change. Deprecation warnings are also\n+appropriate.\n+\n+Unexported names are not strictly part of the public API and may change at","path":"doc/manual/modules.rst","position":20,"original_position":20,"commit_id":"22d62c3539a25b7c4d3a5fd6c2e3aa3fd6c8e30d","original_commit_id":"22d62c3539a25b7c4d3a5fd6c2e3aa3fd6c8e30d","user":{"login":"ScottPJones","id":11798751,"avatar_url":"https://avatars.githubusercontent.com/u/11798751?v=3","gravatar_id":"","url":"https://api.github.com/users/ScottPJones","html_url":"https://github.com/ScottPJones","followers_url":"https://api.github.com/users/ScottPJones/followers","following_url":"https://api.github.com/users/ScottPJones/following{/other_user}","gists_url":"https://api.github.com/users/ScottPJones/gists{/gist_id}","starred_url":"https://api.github.com/users/ScottPJones/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ScottPJones/subscriptions","organizations_url":"https://api.github.com/users/ScottPJones/orgs","repos_url":"https://api.github.com/users/ScottPJones/repos","events_url":"https://api.github.com/users/ScottPJones/events{/privacy}","received_events_url":"https://api.github.com/users/ScottPJones/received_events","type":"User","site_admin":false},"body":">I should add that it would be nice to have a formal way to declare that something like JSON.parse(string) is part of the interface, outside of just documentation. That was discussed briefly in the other issue.\r\n\r\nThat's just what I've been trying to get people to agree to, with `public JSON.parse` :grinning:\r\nbecause it really is orthogonal to whether or not something has documentation.","created_at":"2015-08-19T21:29:50Z","updated_at":"2015-08-19T21:29:50Z","html_url":"https://github.com/JuliaLang/julia/pull/12696#discussion_r37470796","pull_request_url":"https://api.github.com/repos/JuliaLang/julia/pulls/12696","_links":{"self":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/comments/37470796"},"html":{"href":"https://github.com/JuliaLang/julia/pull/12696#discussion_r37470796"},"pull_request":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/12696"}}},"pull_request":{"url":"https://api.github.com/repos/JuliaLang/julia/pulls/12696","id":42836321,"html_url":"https://github.com/JuliaLang/julia/pull/12696","diff_url":"https://github.com/JuliaLang/julia/pull/12696.diff","patch_url":"https://github.com/JuliaLang/julia/pull/12696.patch","issue_url":"https://api.github.com/repos/JuliaLang/julia/issues/12696","number":12696,"state":"open","locked":false,"title":"Document guidance for changes in unexported functions","user":{"login":"rsrock","id":1935770,"avatar_url":"https://avatars.githubusercontent.com/u/1935770?v=3","gravatar_id":"","url":"https://api.github.com/users/rsrock","html_url":"https://github.com/rsrock","followers_url":"https://api.github.com/users/rsrock/followers","following_url":"https://api.github.com/users/rsrock/following{/other_user}","gists_url":"https://api.github.com/users/rsrock/gists{/gist_id}","starred_url":"https://api.github.com/users/rsrock/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rsrock/subscriptions","organizations_url":"https://api.github.com/users/rsrock/orgs","repos_url":"https://api.github.com/users/rsrock/repos","events_url":"https://api.github.com/users/rsrock/events{/privacy}","received_events_url":"https://api.github.com/users/rsrock/received_events","type":"User","site_admin":false},"body":"Fixes #12647\r\n\r\nExplains the public nature of Julia names, and how to obtain some measure of\r\nprivacy when needed.  Also provides guidance for breaking changes in public APIs,\r\nunexported names, and private (underscore) names.\r\n\r\n[ci skip]","created_at":"2015-08-19T16:38:32Z","updated_at":"2015-08-19T21:29:50Z","closed_at":null,"merged_at":null,"merge_commit_sha":"36f8f224029bdca6789115959619d3b0014c0730","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/JuliaLang/julia/pulls/12696/commits","review_comments_url":"https://api.github.com/repos/JuliaLang/julia/pulls/12696/comments","review_comment_url":"https://api.github.com/repos/JuliaLang/julia/pulls/comments{/number}","comments_url":"https://api.github.com/repos/JuliaLang/julia/issues/12696/comments","statuses_url":"https://api.github.com/repos/JuliaLang/julia/statuses/22d62c3539a25b7c4d3a5fd6c2e3aa3fd6c8e30d","head":{"label":"rsrock:rsr/doc-public-private","ref":"rsr/doc-public-private","sha":"22d62c3539a25b7c4d3a5fd6c2e3aa3fd6c8e30d","user":{"login":"rsrock","id":1935770,"avatar_url":"https://avatars.githubusercontent.com/u/1935770?v=3","gravatar_id":"","url":"https://api.github.com/users/rsrock","html_url":"https://github.com/rsrock","followers_url":"https://api.github.com/users/rsrock/followers","following_url":"https://api.github.com/users/rsrock/following{/other_user}","gists_url":"https://api.github.com/users/rsrock/gists{/gist_id}","starred_url":"https://api.github.com/users/rsrock/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rsrock/subscriptions","organizations_url":"https://api.github.com/users/rsrock/orgs","repos_url":"https://api.github.com/users/rsrock/repos","events_url":"https://api.github.com/users/rsrock/events{/privacy}","received_events_url":"https://api.github.com/users/rsrock/received_events","type":"User","site_admin":false},"repo":{"id":8489800,"name":"julia","full_name":"rsrock/julia","owner":{"login":"rsrock","id":1935770,"avatar_url":"https://avatars.githubusercontent.com/u/1935770?v=3","gravatar_id":"","url":"https://api.github.com/users/rsrock","html_url":"https://github.com/rsrock","followers_url":"https://api.github.com/users/rsrock/followers","following_url":"https://api.github.com/users/rsrock/following{/other_user}","gists_url":"https://api.github.com/users/rsrock/gists{/gist_id}","starred_url":"https://api.github.com/users/rsrock/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rsrock/subscriptions","organizations_url":"https://api.github.com/users/rsrock/orgs","repos_url":"https://api.github.com/users/rsrock/repos","events_url":"https://api.github.com/users/rsrock/events{/privacy}","received_events_url":"https://api.github.com/users/rsrock/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rsrock/julia","description":"The Julia Language: A fresh approach to technical computing.","fork":true,"url":"https://api.github.com/repos/rsrock/julia","forks_url":"https://api.github.com/repos/rsrock/julia/forks","keys_url":"https://api.github.com/repos/rsrock/julia/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rsrock/julia/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rsrock/julia/teams","hooks_url":"https://api.github.com/repos/rsrock/julia/hooks","issue_events_url":"https://api.github.com/repos/rsrock/julia/issues/events{/number}","events_url":"https://api.github.com/repos/rsrock/julia/events","assignees_url":"https://api.github.com/repos/rsrock/julia/assignees{/user}","branches_url":"https://api.github.com/repos/rsrock/julia/branches{/branch}","tags_url":"https://api.github.com/repos/rsrock/julia/tags","blobs_url":"https://api.github.com/repos/rsrock/julia/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rsrock/julia/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rsrock/julia/git/refs{/sha}","trees_url":"https://api.github.com/repos/rsrock/julia/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rsrock/julia/statuses/{sha}","languages_url":"https://api.github.com/repos/rsrock/julia/languages","stargazers_url":"https://api.github.com/repos/rsrock/julia/stargazers","contributors_url":"https://api.github.com/repos/rsrock/julia/contributors","subscribers_url":"https://api.github.com/repos/rsrock/julia/subscribers","subscription_url":"https://api.github.com/repos/rsrock/julia/subscription","commits_url":"https://api.github.com/repos/rsrock/julia/commits{/sha}","git_commits_url":"https://api.github.com/repos/rsrock/julia/git/commits{/sha}","comments_url":"https://api.github.com/repos/rsrock/julia/comments{/number}","issue_comment_url":"https://api.github.com/repos/rsrock/julia/issues/comments{/number}","contents_url":"https://api.github.com/repos/rsrock/julia/contents/{+path}","compare_url":"https://api.github.com/repos/rsrock/julia/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rsrock/julia/merges","archive_url":"https://api.github.com/repos/rsrock/julia/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rsrock/julia/downloads","issues_url":"https://api.github.com/repos/rsrock/julia/issues{/number}","pulls_url":"https://api.github.com/repos/rsrock/julia/pulls{/number}","milestones_url":"https://api.github.com/repos/rsrock/julia/milestones{/number}","notifications_url":"https://api.github.com/repos/rsrock/julia/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rsrock/julia/labels{/name}","releases_url":"https://api.github.com/repos/rsrock/julia/releases{/id}","created_at":"2013-02-28T22:43:59Z","updated_at":"2015-03-13T15:54:55Z","pushed_at":"2015-08-19T16:37:51Z","git_url":"git://github.com/rsrock/julia.git","ssh_url":"git@github.com:rsrock/julia.git","clone_url":"https://github.com/rsrock/julia.git","svn_url":"https://github.com/rsrock/julia","homepage":"http://julialang.org/","size":78352,"stargazers_count":0,"watchers_count":0,"language":"Julia","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"JuliaLang:master","ref":"master","sha":"e5e8ed5d646b4392ae190196e64c5005f5292c28","user":{"login":"JuliaLang","id":743164,"avatar_url":"https://avatars.githubusercontent.com/u/743164?v=3","gravatar_id":"","url":"https://api.github.com/users/JuliaLang","html_url":"https://github.com/JuliaLang","followers_url":"https://api.github.com/users/JuliaLang/followers","following_url":"https://api.github.com/users/JuliaLang/following{/other_user}","gists_url":"https://api.github.com/users/JuliaLang/gists{/gist_id}","starred_url":"https://api.github.com/users/JuliaLang/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JuliaLang/subscriptions","organizations_url":"https://api.github.com/users/JuliaLang/orgs","repos_url":"https://api.github.com/users/JuliaLang/repos","events_url":"https://api.github.com/users/JuliaLang/events{/privacy}","received_events_url":"https://api.github.com/users/JuliaLang/received_events","type":"Organization","site_admin":false},"repo":{"id":1644196,"name":"julia","full_name":"JuliaLang/julia","owner":{"login":"JuliaLang","id":743164,"avatar_url":"https://avatars.githubusercontent.com/u/743164?v=3","gravatar_id":"","url":"https://api.github.com/users/JuliaLang","html_url":"https://github.com/JuliaLang","followers_url":"https://api.github.com/users/JuliaLang/followers","following_url":"https://api.github.com/users/JuliaLang/following{/other_user}","gists_url":"https://api.github.com/users/JuliaLang/gists{/gist_id}","starred_url":"https://api.github.com/users/JuliaLang/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JuliaLang/subscriptions","organizations_url":"https://api.github.com/users/JuliaLang/orgs","repos_url":"https://api.github.com/users/JuliaLang/repos","events_url":"https://api.github.com/users/JuliaLang/events{/privacy}","received_events_url":"https://api.github.com/users/JuliaLang/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/JuliaLang/julia","description":"The Julia Language: A fresh approach to technical computing.","fork":false,"url":"https://api.github.com/repos/JuliaLang/julia","forks_url":"https://api.github.com/repos/JuliaLang/julia/forks","keys_url":"https://api.github.com/repos/JuliaLang/julia/keys{/key_id}","collaborators_url":"https://api.github.com/repos/JuliaLang/julia/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/JuliaLang/julia/teams","hooks_url":"https://api.github.com/repos/JuliaLang/julia/hooks","issue_events_url":"https://api.github.com/repos/JuliaLang/julia/issues/events{/number}","events_url":"https://api.github.com/repos/JuliaLang/julia/events","assignees_url":"https://api.github.com/repos/JuliaLang/julia/assignees{/user}","branches_url":"https://api.github.com/repos/JuliaLang/julia/branches{/branch}","tags_url":"https://api.github.com/repos/JuliaLang/julia/tags","blobs_url":"https://api.github.com/repos/JuliaLang/julia/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/JuliaLang/julia/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/JuliaLang/julia/git/refs{/sha}","trees_url":"https://api.github.com/repos/JuliaLang/julia/git/trees{/sha}","statuses_url":"https://api.github.com/repos/JuliaLang/julia/statuses/{sha}","languages_url":"https://api.github.com/repos/JuliaLang/julia/languages","stargazers_url":"https://api.github.com/repos/JuliaLang/julia/stargazers","contributors_url":"https://api.github.com/repos/JuliaLang/julia/contributors","subscribers_url":"https://api.github.com/repos/JuliaLang/julia/subscribers","subscription_url":"https://api.github.com/repos/JuliaLang/julia/subscription","commits_url":"https://api.github.com/repos/JuliaLang/julia/commits{/sha}","git_commits_url":"https://api.github.com/repos/JuliaLang/julia/git/commits{/sha}","comments_url":"https://api.github.com/repos/JuliaLang/julia/comments{/number}","issue_comment_url":"https://api.github.com/repos/JuliaLang/julia/issues/comments{/number}","contents_url":"https://api.github.com/repos/JuliaLang/julia/contents/{+path}","compare_url":"https://api.github.com/repos/JuliaLang/julia/compare/{base}...{head}","merges_url":"https://api.github.com/repos/JuliaLang/julia/merges","archive_url":"https://api.github.com/repos/JuliaLang/julia/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/JuliaLang/julia/downloads","issues_url":"https://api.github.com/repos/JuliaLang/julia/issues{/number}","pulls_url":"https://api.github.com/repos/JuliaLang/julia/pulls{/number}","milestones_url":"https://api.github.com/repos/JuliaLang/julia/milestones{/number}","notifications_url":"https://api.github.com/repos/JuliaLang/julia/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/JuliaLang/julia/labels{/name}","releases_url":"https://api.github.com/repos/JuliaLang/julia/releases{/id}","created_at":"2011-04-21T07:01:50Z","updated_at":"2015-08-19T15:46:05Z","pushed_at":"2015-08-19T21:23:48Z","git_url":"git://github.com/JuliaLang/julia.git","ssh_url":"git@github.com:JuliaLang/julia.git","clone_url":"https://github.com/JuliaLang/julia.git","svn_url":"https://github.com/JuliaLang/julia","homepage":"http://julialang.org/","size":214620,"stargazers_count":5881,"watchers_count":5881,"language":"Julia","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":1277,"mirror_url":null,"open_issues_count":1331,"forks":1277,"open_issues":1331,"watchers":5881,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/12696"},"html":{"href":"https://github.com/JuliaLang/julia/pull/12696"},"issue":{"href":"https://api.github.com/repos/JuliaLang/julia/issues/12696"},"comments":{"href":"https://api.github.com/repos/JuliaLang/julia/issues/12696/comments"},"review_comments":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/12696/comments"},"review_comment":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/JuliaLang/julia/pulls/12696/commits"},"statuses":{"href":"https://api.github.com/repos/JuliaLang/julia/statuses/22d62c3539a25b7c4d3a5fd6c2e3aa3fd6c8e30d"}}}}