Skip to content

IDL Problem Code 62 with alias docs-return-not-needed

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 is present for a routine that does not return a value. This includes procedures and procedure methods.

Here's an example that produces this error:

idl
;+
; :Returns: Number
;-
pro mypro
  compile_opt idl2
end

To fix it, remove the tag from the docs:

idl
;+
;
;-
pro mypro
  compile_opt idl2
end

Licensed under MIT.