cfdocs icon indicating copy to clipboard operation
cfdocs copied to clipboard

Guides for functions with arguments only used in one of multiple use cases

Open shaedrich opened this issue 8 years ago • 3 comments

There are functions with arguments which can only be used when

  • Another argument is used as well
  • Another attribut has a specific value

Should there be guides to explain when to use which argument, so the doc itself stays in order? Should arguments get labels like "CF9+" if they depend on another argument or it's value?

Relates to #530 #517

shaedrich avatar Sep 05 '17 10:09 shaedrich

See issue #525 I suggested a possible solution adding position and required-when option to the params object

pfreitag avatar Sep 06 '17 17:09 pfreitag

I think of functions like cfpdf and cfloop which are more complex and cover multiple very different cases.

shaedrich avatar Sep 06 '17 19:09 shaedrich

In some cases it looks like a completely different function so maybe we could use an url param to show/hide params and syntaxes depending on mode.

shaedrich avatar Feb 08 '18 15:02 shaedrich