Webel: Mathematica: WISHLIST: Support for EXTRACTABLE structured documentation for individual arguments to functions RIGHT IN/NEAR THE CODE. Yes it is needed. Really it is.

Webel IT Australia promotes the amazing Mathematica tool and the powerful Wolfram Language and offers professional Mathematica services for computational computing and data analysis. Our Mathematica tips, issue tracking, and wishlist is offered here most constructively to help improve the tool and language and support the Mathematica user community.
DISCLAIMER: Wolfram Research does not officially endorse analysis by Webel IT Australia.
Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
Keywords
Click on the image to view it full size
This just does not make the grade:

f::usage = "f[arg1,arg2] This function has arguments arg1 and arg2, which are not individually documented, unless I use a tedious newlines and make something up."
Dr Darren says:
Every major programming language has a decent structured way to document functions arguments right in or near the code, Wolfram Language does not, and it's a major shortcoming.

The Wolfram Workbench offers some modest documentation support, but it's not well enough coupled to the code, i.e. it requires editing documentation separately from coding, so they can get out of sync easily. It's dangerously WET not DRY.

And for anybody who is used to documenting functions and their arguments coherently, easily, right there where the code is, the MMA approach is beyond awful. Yes, awful. Awful. I'm talking to you Wolfram Research!

Relates to
Related notes
Related notes (backlinks)
Related snippets (extracts)
Visit also
Visit also (backlinks)
External links