Skip to content

IDL Problem Code 47 with alias args-first

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 problem occurs when argument definitions are found after keywords (optional parameters).

Here's an example of this error:

idl
function myfunc, kw = kw, arg1
  ;                       ^^^^ args first
  compile_opt idl2
  return,1
end

Which can be fixed by reducing to a single statment:

idl
function myfunc, arg1, kw = kw
  ;              ^^^^ OK!
  compile_opt idl2
  return,1
end

Licensed under MIT.