Skip to main content
Mathematica

Return to Question

changed function name to something more generic
Source Link
QuantumDot
QuantumDot
  • 19.8k
  • 7
  • 48
  • 124

I have defined a function PassVeltBfoo in some complicated way. But now I would like to add a little documentation that gives the user information on how it is to be used.

I know that the ? symbol could be placed before a built-in function to generate useful information about that built-in function. Is there a way I can add helpful information about my PassVeltBfoo function in a similar way?

I have defined a function PassVeltB in some complicated way. But now I would like to add a little documentation that gives the user information on how it is to be used.

I know that the ? symbol could be placed before a built-in function to generate useful information about that built-in function. Is there a way I can add helpful information about my PassVeltB function in a similar way?

I have defined a function foo in some complicated way. But now I would like to add a little documentation that gives the user information on how it is to be used.

I know that the ? symbol could be placed before a built-in function to generate useful information about that built-in function. Is there a way I can add helpful information about my foo function in a similar way?

edited tags
Link
Mr.Wizard
Mr.Wizard
  • 273.1k
  • 34
  • 595
  • 1.4k
Tweeted twitter.com/#!/StackMma/status/286694511109894144
Source Link
QuantumDot
QuantumDot
  • 19.8k
  • 7
  • 48
  • 124

How to create 'help' `?` for a function (as documentation)

I have defined a function PassVeltB in some complicated way. But now I would like to add a little documentation that gives the user information on how it is to be used.

I know that the ? symbol could be placed before a built-in function to generate useful information about that built-in function. Is there a way I can add helpful information about my PassVeltB function in a similar way?