Webel: Mathematica: WISHLIST: Support for EXTRACTABLE structured documentation for individual arguments of functions RIGHT IN/NEAR THE CODE. Yes it is needed, really it is. (And ::usage support for "methods" would be nice too.)

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
Dr Darren says:
If I weren't (mostly) such a huge fan of Wolfram Mathematica I wouldn't bother to complain (and "in public") about its short-comings, and the documentation system is one of them, at least for the complex projects I apply Mathematica to.
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, but the 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.

For any code-oriented developer who is used to documenting functions and their arguments coherently, easily, right there where the code is (and used to staying in their "coding zone"), the current Mathematica ::usage and Documentation Tools are approaches inadequate.

The quality of the documentation itself in the main Documentation Center for the Wolfram Language and Mathematica is mostly excellent.

The Documentation Tools approach (which stores documentation in separate "parallel" folders within a Paclet) may be fine for smaller projects with only a handful of packages with not too many functions.

But for the very large, very complex Mathematica applications at the scale Webel IT Australia is (otherwise very successfully) using Mathematica for? Nope!

Webel IT Australia has its own code-oriented help system!

Note that Dr Darren of Webel IT Australia does not just whinge; he solves things. Welcome to the Webel Doc` (structured ::usage generation package) and the HelpF` (for functions) and HelpO` (for "methods") help registry packages:

Which are supported by:

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