Skip to content

Commit f6ea29f

Browse files
committed
Add missing return types in YARD documentation
- Add [void] return type for all database operation methods - Add proper return types for Configuration accessors
1 parent 532d172 commit f6ea29f

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

lib/fx/configuration.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ class Configuration
44
# The F(x) database adapter instance to use when executing SQL.
55
#
66
# Defaults to an instance of {Fx::Adapters::Postgres}
7-
# @return Fx adapter
7+
# @return [Fx::Adapters::Postgres] Fx adapter
88
attr_accessor :database
99

1010
# Prioritizes the order in the schema.rb of functions before other
1111
# statements in order to make directly schema load work when using functions
1212
# in statements below, i.e.: default column values.
1313
#
1414
# Defaults to false
15-
# @return Boolean
15+
# @return [Boolean] Boolean
1616
attr_accessor :dump_functions_at_beginning_of_schema
1717

1818
def initialize

lib/fx/statements.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module Statements
1010
# @param sql_definition [String] The SQL query for the function schema.
1111
# If both `sql_definition` and `version` are provided,
1212
# `sql_definition` takes precedence.
13-
# @return The database response from executing the create statement.
13+
# @return [void] The database response from executing the create statement.
1414
#
1515
# @example Create from `db/functions/uppercase_users_name_v02.sql`
1616
# create_function(:uppercase_users_name, version: 2)
@@ -42,7 +42,7 @@ def create_function(name, options = {})
4242
# @param revert_to_version [Integer] Used to reverse the `drop_function`
4343
# command on `rake db:rollback`. The provided version will be passed as
4444
# the `version` argument to {#create_function}.
45-
# @return The database response from executing the drop statement.
45+
# @return [void] The database response from executing the drop statement.
4646
#
4747
# @example Drop a function, rolling back to version 2 on rollback
4848
# drop_function(:uppercase_users_name, revert_to_version: 2)
@@ -60,7 +60,7 @@ def drop_function(name, options = {})
6060
# @param sql_definition [String] The SQL query for the function schema.
6161
# If both `sql_definition` and `version` are provided,
6262
# `sql_definition` takes precedence.
63-
# @return The database response from executing the create statement.
63+
# @return [void] The database response from executing the create statement.
6464
#
6565
# @example Update function to a given version
6666
# update_function(
@@ -100,7 +100,7 @@ def update_function(name, options = {})
100100
# @param sql_definition [String] The SQL query for the function. An error
101101
# will be raised if `sql_definition` and `version` are both set,
102102
# as they are mutually exclusive.
103-
# @return The database response from executing the create statement.
103+
# @return [void] The database response from executing the create statement.
104104
#
105105
# @example Create trigger from `db/triggers/uppercase_users_name_v01.sql`
106106
# create_trigger(:uppercase_users_name, version: 1)
@@ -134,7 +134,7 @@ def create_trigger(name, options = {})
134134
# @param revert_to_version [Integer] Used to reverse the `drop_trigger`
135135
# command on `rake db:rollback`. The provided version will be passed as
136136
# the `version` argument to {#create_trigger}.
137-
# @return The database response from executing the drop statement.
137+
# @return [void] The database response from executing the drop statement.
138138
#
139139
# @example Drop a trigger, rolling back to version 3 on rollback
140140
# drop_trigger(:log_inserts, on: :users, revert_to_version: 3)
@@ -158,7 +158,7 @@ def drop_trigger(name, options = {})
158158
# as they are mutually exclusive.
159159
# @param revert_to_version [Integer] The version number to rollback to on
160160
# `rake db rollback`
161-
# @return The database response from executing the create statement.
161+
# @return [void] The database response from executing the create statement.
162162
#
163163
# @example Update trigger to a given version
164164
# update_trigger(

0 commit comments

Comments
 (0)