Skip to content

Commit 3c52500

Browse files
committed
Fix more API docs
1 parent 2392a5f commit 3c52500

File tree

6 files changed

+9
-11
lines changed

6 files changed

+9
-11
lines changed

lib/hanami/action.rb

+2-4
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,8 @@ def handle(request, response)
364364
#
365365
# @since 0.2.0
366366
#
367-
# @see Hanami::Action::Throwable#handle_exception
368-
# @see Hanami::Http::Status:ALL
367+
# @see Hanami::Action.handle_exception
368+
# @see https://rubydoc.info/github/rack/rack/Rack/Utils
369369
#
370370
# @example Basic usage
371371
# require "hanami/controller"
@@ -528,8 +528,6 @@ def _run_after_callbacks(*args)
528528
#
529529
# @since 0.5.0
530530
#
531-
# @see Hanami::Action#_requires_no_body?
532-
#
533531
# @example
534532
# require "hanami/controller"
535533
#

lib/hanami/action/cache.rb

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ class Action
55
# Cache type API
66
#
77
# @since 0.3.0
8+
# @api private
89
#
910
# @see Hanami::Action::Response#cache_control
1011
# @see Hanami::Action::Response#expires

lib/hanami/action/config.rb

+1-3
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,13 @@ def format(*formats)
137137

138138
# @!attribute [rw] root_directory
139139
#
140-
# Sets the the for the public directory, which is used for file downloads.
140+
# Sets the the root directory for the public directory, which is used for file downloads.
141141
# This must be an existent directory.
142142
#
143143
# Defaults to the current working directory.
144144
#
145145
# @return [String] the directory path
146146
#
147-
# @api private
148-
#
149147
# @since 1.0.0
150148

151149
# @!attribute [rw] public_directory

lib/hanami/action/cookie_jar.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class Action
1111
#
1212
# @since 0.1.0
1313
#
14-
# @see Hanami::Action::Cookies#cookies
14+
# @see Hanami::Action::Response#cookies
1515
class CookieJar
1616
# @since 0.4.5
1717
# @api private

lib/hanami/action/cookies.rb

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ module Hanami
44
class Action
55
# Cookies API
66
#
7-
# This module isn't included by default.
7+
# If you want cookies in your actions then include this module.
8+
# It's not included by default.
89
#
910
# @since 0.1.0
1011
#

lib/hanami/action/csrf_protection.rb

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ class Action
2929
#
3030
# @since 0.4.0
3131
#
32-
# @see https://www.owasp.org/index.php/Cross-Site_Request_Forgery_%28CSRF%29
33-
# @see https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet
32+
# @see https://owasp.org/www-community/attacks/csrf
33+
# @see https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html
3434
#
3535
# @example Custom Handling
3636
# module Web::Controllers::Books

0 commit comments

Comments
 (0)