aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/api_documentation_guidelines.md
diff options
context:
space:
mode:
authorMatthew Draper <matthew@trebex.net>2017-04-09 00:31:58 +0930
committerMatthew Draper <matthew@trebex.net>2017-04-09 00:55:13 +0930
commit668f8691f1017042e238497d1a5b7b8bf1c43819 (patch)
treebe1b0b8dea784a9aa74d22496f8156057335677f /guides/source/api_documentation_guidelines.md
parent28079868d0e70bdac80c76cf806afd517edfe1e7 (diff)
downloadrails-668f8691f1017042e238497d1a5b7b8bf1c43819.tar.gz
rails-668f8691f1017042e238497d1a5b7b8bf1c43819.tar.bz2
rails-668f8691f1017042e238497d1a5b7b8bf1c43819.zip
Remove mentions and instructions for docrails
It's been retired; all contributions now come in via PRs.
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
-rw-r--r--guides/source/api_documentation_guidelines.md4
1 files changed, 0 insertions, 4 deletions
diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md
index 34b9c0d2ca..3c61754982 100644
--- a/guides/source/api_documentation_guidelines.md
+++ b/guides/source/api_documentation_guidelines.md
@@ -333,10 +333,6 @@ As a contributor, it's important to think about whether this API is meant for en
A class or module is marked with `:nodoc:` to indicate that all methods are internal API and should never be used directly.
-If you come across an existing `:nodoc:` you should tread lightly. Consider asking someone from the core team or author of the code before removing it. This should almost always happen through a pull request instead of the docrails project.
-
-A `:nodoc:` should never be added simply because a method or class is missing documentation. There may be an instance where an internal public method wasn't given a `:nodoc:` by mistake, for example when switching a method from private to public visibility. When this happens it should be discussed over a PR on a case-by-case basis and never committed directly to docrails.
-
To summarize, the Rails team uses `:nodoc:` to mark publicly visible methods and classes for internal use; changes to the visibility of API should be considered carefully and discussed over a pull request first.
Regarding the Rails Stack