Skip to content

IDL Problem Code 63 with alias docs-not-real-param

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 indicates that a documented argument or keyword doesn't exist in your code.

Here's an example that produces this error:

idl
;+
; :Arguments:
;   arg1: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;   arg2: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;
;-
pro mypro, arg1
  compile_opt idl2
end

To fix it, either remove from the docs or add the parameter:

idl
;+
; :Arguments:
;   arg1: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;
;-
pro mypro, arg1
  compile_opt idl2
end
idl
;+
; :Arguments:
;   arg1: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;   arg2: bidirectional, required, any
;     Placeholder docs for argument, keyword, or property
;
;-
pro mypro, arg1, arg2
  compile_opt idl2
end

Licensed under MIT.