Skip to content

API methods used in the migration guide do not appear in RDoc #1657

@geeksam

Description

@geeksam

Issue Description

I wanted to update Faraday on an older application, but the sentry-raven dependency was preventing it. YAK SHAVING, HERE WE COME!

Reproduction Steps

  • In the application's Gemfile, replace sentry-raven with sentry-rails and sentry-ruby and run bundle
  • Get a failure message about the Gemfile.lock being locked to an older version of Faraday
  • Run bundle update faraday
  • Update config/initializers/sentry.rb
  • Grep the project for references to Raven
    • .capture_exception is easy enough...
    • Raven.user_context doesn't seem to have an equivalent. Consult migration guide, see mention of Sentry.set_user method instead
    • Download the RDoc for both sentry-ruby and sentry-rails into, e.g., Dash
    • Search for set_user in the RDoc for both sentry-rails and sentry-ruby

Expected Behavior

Documentation that describes the shape of data that MUST/SHOULD/MAY (see RFC 2119) be passed to the Sentry.set_user method.

Actual Behavior

The Sentry.set_user method does not appear in the docs at all.

Ruby Version

all

SDK Version

4.8.1

Integration and Its Version

No response

Sentry Config

No response

Metadata

Metadata

Assignees

Labels

No labels
No labels
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions