Skip to content

IDL Problem Code 60 with alias docs-return-has-no-type

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 :Return: tag in documentation does not have any text indicating the type that gets returned.

Here's an example that produces this error:

idl
;+
; :Returns:
;-
function myfunc
  compile_opt idl2
  return, 42
end

To fix it, add a type to the :Returns: docs tag:

idl
;+
; :Returns: Number
;-
function myfunc
  compile_opt idl2
  return, 42
end

Licensed under MIT.