IDL Problem Code 56 with alias docs-invalid-private

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 the documentation for a parameter (argument or keyword) being hidden is not either private or public.

Here's an example that highlights the problem:

;+
; :Returns: Number
;
; :Arguments:
;   arg: in, required, Number, hidden
;     My favorite arg
;
;-
function myfunc, arg
  compile_opt idl2
  return, 42 + arg
end

To fix the issue, adjust the docs to be one of the following:

Private parameter

;+
; :Returns: Number
;
; :Arguments:
;   arg: in, required, Number, private
;     My favorite arg
;
;-
function myfunc, arg
  compile_opt idl2
  return, 42 + arg
end

Public parameter

;+
; :Returns: Number
;
; :Arguments:
;   arg: in, required, Number, public
;     My favorite arg
;
;-
function myfunc, arg
  compile_opt idl2
  return, 42 + arg
end

Inferred public

;+
; :Returns: Number
;
; :Arguments:
;   arg: in, required, Number
;     My favorite arg
;
;-
function myfunc, arg
  compile_opt idl2
  return, 42 + arg
end