diff options
| author | Leonel Galán <leonel@getstealz.com> | 2017-04-25 10:39:46 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-25 10:39:46 -0500 |
| commit | f5b2a0ef408f01dd9f12b456f5e4bb41ebb4cb76 (patch) | |
| tree | 4afabfef205d5fbd546946a16bc6cf5eb36279e9 /guides/source/api_documentation_guidelines.md | |
| parent | 8648f289f01656b2258687126108c389127108e0 (diff) | |
| parent | b32d64df5e5160e25804c7019e2da76bd115f3a6 (diff) | |
| download | rails-f5b2a0ef408f01dd9f12b456f5e4bb41ebb4cb76.tar.gz rails-f5b2a0ef408f01dd9f12b456f5e4bb41ebb4cb76.tar.bz2 rails-f5b2a0ef408f01dd9f12b456f5e4bb41ebb4cb76.zip | |
Merge branch 'master' into bug/filtered_parameters_class
Diffstat (limited to 'guides/source/api_documentation_guidelines.md')
| -rw-r--r-- | guides/source/api_documentation_guidelines.md | 4 |
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 |