Page 1 of 1

[PSS 2016]CBH Examples

Posted: Thu Nov 10, 2016 4:55 am
by Bosparan

when auto-generating Comment Based Help, it will generate an example for the function it is generated for. This example consists basically of the function name itself and the first two parameters defined.
Even when these parameters are part of different parametersets and cannot naturally occur together.

Also, for complex functions I always need more than a single example, so I have to create multiple entries manually. While much of that simply cannot be automatized, you can parse the function to create one example for each parameterset, with only the mandatory parameters automatically added. That would make documenting complex functions a lot easier and be even more useful when adding proper help on elder functions that may not have gotten examples at all so far (shame on us, I'd guess, but some of the eldest relics ...).