{"action":"created","issue":{"url":"https://api.github.com/repos/JuliaLang/julia/issues/12064","labels_url":"https://api.github.com/repos/JuliaLang/julia/issues/12064/labels{/name}","comments_url":"https://api.github.com/repos/JuliaLang/julia/issues/12064/comments","events_url":"https://api.github.com/repos/JuliaLang/julia/issues/12064/events","html_url":"https://github.com/JuliaLang/julia/issues/12064","id":93786405,"number":12064,"title":"Document privacy of type-fields","user":{"login":"mauro3","id":4098145,"avatar_url":"https://avatars.githubusercontent.com/u/4098145?v=3","gravatar_id":"","url":"https://api.github.com/users/mauro3","html_url":"https://github.com/mauro3","followers_url":"https://api.github.com/users/mauro3/followers","following_url":"https://api.github.com/users/mauro3/following{/other_user}","gists_url":"https://api.github.com/users/mauro3/gists{/gist_id}","starred_url":"https://api.github.com/users/mauro3/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mauro3/subscriptions","organizations_url":"https://api.github.com/users/mauro3/orgs","repos_url":"https://api.github.com/users/mauro3/repos","events_url":"https://api.github.com/users/mauro3/events{/privacy}","received_events_url":"https://api.github.com/users/mauro3/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":61,"created_at":"2015-07-08T13:13:46Z","updated_at":"2015-07-10T08:33:32Z","closed_at":null,"body":"It is not documented that fields of types are considered private (at least by some people), as @nalimilan mentioned over in [julia-users]( https://groups.google.com/d/msg/julia-users/yC-sw9ykZwM/-607E_FPtl0J).  It's probably worth giving some guidelines in the documentation when fields are considered private.  As that is probably not always true, for instance when using a type just to store stuff.\r\n\r\nAlso, using an leading underscore is sometimes used to denote privacy of methods or (extra?) privacy of fields.  When should `_` be used vs just assume privacy of fields?  When should methods use a `_`?\r\n\r\nIt is probably worthwhile to reach some sort of consensus about this and documenting it before going forward with field overloading (#1974 and PR #5848)."},"comment":{"url":"https://api.github.com/repos/JuliaLang/julia/issues/comments/120299537","html_url":"https://github.com/JuliaLang/julia/issues/12064#issuecomment-120299537","issue_url":"https://api.github.com/repos/JuliaLang/julia/issues/12064","id":120299537,"user":{"login":"lobingera","id":5199059,"avatar_url":"https://avatars.githubusercontent.com/u/5199059?v=3","gravatar_id":"","url":"https://api.github.com/users/lobingera","html_url":"https://github.com/lobingera","followers_url":"https://api.github.com/users/lobingera/followers","following_url":"https://api.github.com/users/lobingera/following{/other_user}","gists_url":"https://api.github.com/users/lobingera/gists{/gist_id}","starred_url":"https://api.github.com/users/lobingera/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lobingera/subscriptions","organizations_url":"https://api.github.com/users/lobingera/orgs","repos_url":"https://api.github.com/users/lobingera/repos","events_url":"https://api.github.com/users/lobingera/events{/privacy}","received_events_url":"https://api.github.com/users/lobingera/received_events","type":"User","site_admin":false},"created_at":"2015-07-10T08:33:32Z","updated_at":"2015-07-10T08:33:32Z","body":"Now i'm lost. afaics Public fields are the default (and btw: current situation) and we want to document non-public fields by adding an underscore? "}}