IDL Problem Code 48 with alias docs-missing-args

Want to disable me? Check out the configuration guide to learn more.

Documentation Best Practice

This problem indicates that there's an opportunity to improve the documentation for your code.

This helps make sure the extension can properly detect types, provide a better user experience, and ensures other users can be successful with code that you write.

Want to automate documentation generation? Learn about comment style and AutoDoc here.

This error is reported when your documentation is missing the :Arguments: tag when a routine definition has arguments.

Here's an example:

;+
;
;-
pro myclass::mymethod, var1
  compile_opt idl2
end

To fix it, add the :Arguments: section to the documentation:

;+
; :Arguments:
;   var1: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;
;-
pro myclass::mymethod, var1
  compile_opt idl2
end