Skip to content

Commit

Permalink
Fix API docs issues (#1289)
Browse files Browse the repository at this point in the history
Fix warnings output by YARD to fix the API docs.
Updated renamed parameters.

[skip changeset]
[skip review]
[skip ci]
  • Loading branch information
tombruijn authored Sep 6, 2024
1 parent e270cb2 commit 0b41476
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 1 addition & 1 deletion lib/appsignal/check_in.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class << self
# # your code
# end
#
# @param name [String] name of the cron check-in to report.
# @param identifier [String] identifier of the cron check-in to report.
# @yield the block to monitor.
# @return [void]
# @since 3.13.0
Expand Down
4 changes: 1 addition & 3 deletions lib/appsignal/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -214,14 +214,12 @@ def self.determine_root_path
# Initialize a new configuration object for AppSignal.
#
# @param root_path [String] Root path of the app.
# @param initial_env [String] The environment to load when AppSignal is started. It
# @param env [String] The environment to load when AppSignal is started. It
# will look for an environment with this name in the `config/appsignal.yml`
# config file.
# @param logger [Logger] The logger to use for the AppSignal gem. This is
# used by the configuration class only. Default:
# {Appsignal.internal_logger}. See also {Appsignal.start}.
# @param config_file [String] Custom config file location. Default
# `config/appsignal.yml`.
#
# @api private
# @see https://docs.appsignal.com/ruby/configuration/
Expand Down

0 comments on commit 0b41476

Please sign in to comment.