GitHub PullRequestReviewCommentEvent at 2014-05-16 19:54:31
Repository: rails
Actor: chancancode
Payload: {"comment":{"url":"https://api.github.com/repos/rails/rails/pulls/comments/12756596","id":12756596,"diff_hunk":"@@ -286,3 +286,37 @@ self.class_eval %{\n   end\n }\n ```\n+\n+Method Visibility\n+-----------------\n+\n+When documenting methods in Rails, it's important to remember the difference between Public-API vs. Internal-API.\n+\n+Even though Ruby has the distinction between public and private methods, Rails doesn't use method visibility in the same way.\n+\n+Instead of making all Internal-API private, Rails uses the `:nodoc:` directive for non-user-facing API.\n+\n+This means that there are public methods in Rails that aren't meant for user consumption.","path":"guides/source/api_documentation_guidelines.md","position":14,"original_position":14,"commit_id":"e2e174da06a158b1a3b922ba53bf23032ffe9aff","original_commit_id":"e2e174da06a158b1a3b922ba53bf23032ffe9aff","user":{"login":"chancancode","id":55829,"avatar_url":"https://avatars.githubusercontent.com/u/55829?","gravatar_id":"22bb3e56828870ee9a0dd93aeadbe04a","url":"https://api.github.com/users/chancancode","html_url":"https://github.com/chancancode","followers_url":"https://api.github.com/users/chancancode/followers","following_url":"https://api.github.com/users/chancancode/following{/other_user}","gists_url":"https://api.github.com/users/chancancode/gists{/gist_id}","starred_url":"https://api.github.com/users/chancancode/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/chancancode/subscriptions","organizations_url":"https://api.github.com/users/chancancode/orgs","repos_url":"https://api.github.com/users/chancancode/repos","events_url":"https://api.github.com/users/chancancode/events{/privacy}","received_events_url":"https://api.github.com/users/chancancode/received_events","type":"User","site_admin":false},"body":"\"... If your application depends on these internal APIs, your application might break or behave differently when you upgrade Rails.\"\r\n\r\nside note: There are :nodoc:'ed classes/modules too\r\n\r\n","created_at":"2014-05-16T19:54:31Z","updated_at":"2014-05-16T19:54:31Z","html_url":"https://github.com/rails/rails/pull/15115#discussion_r12756596","pull_request_url":"https://api.github.com/repos/rails/rails/pulls/15115","_links":{"self":{"href":"https://api.github.com/repos/rails/rails/pulls/comments/12756596"},"html":{"href":"https://github.com/rails/rails/pull/15115#discussion_r12756596"},"pull_request":{"href":"https://api.github.com/repos/rails/rails/pulls/15115"}}}}