Ruby Docs: Autogenerated docs incorrectly list class methods as instance method #1885
Labels
documentation
hacktoberfest
jul-sep qtr
Represents proposed work item for the Jul-Sep quarter
technical debt
Milestone
Owing to the fact that our
NewRelic::Agent
class (lib/new_relic/agent.rb
) utilizes theextend self
pragma to define class methods without usingdef self.*
, our autogenerated RDoc content incorrectly ends up referring to class methods as instance methods.For example, for
NewRelic::Agent.set_transaction_name
...Incorrect
This page:
https://rubydoc.info/github/newrelic/newrelic-ruby-agent/NewRelic/Agent#set_transaction_name-instance_method
#
) instead of a class method (uses.
).Correct
This page:
https://docs.newrelic.com/docs/apm/agents/ruby-agent/api-guides/ruby-custom-instrumentation/#naming-transactions
In order to get the autogenerated docs to correctly recognize methods as class methods, we'll likely need to do one or more of the following:
Acceptance criteria: All autogenerated RDoc content matches the already-correct manually created documentation.
The text was updated successfully, but these errors were encountered: