IDL Problem Code 50 with alias docs-missing-kws

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 :Keywords: tag when a routine definition has keywords.

Here's an example:

;+
;
;-
pro myclass::mymethod, kw1 = kw1
  compile_opt idl2
end

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

;+
; :Keywords:
;   kw1: bidirectional, optional, any
;     Placeholder docs for argument, keyword, or property
;
;-
pro myclass::mymethod, kw1 = kw1
  compile_opt idl2
end