IDL Problem Code 59 with alias docs-left-align

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 you have in your code is not consistent with the left-aligned spacing.

This matters because, when we parse your docs, the spacing indicates where we start parsing extracting text and your docs can be cut off.

Here's an example that highlights the problem:

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

To fix the issue, correct the left-alignment:

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