Comment on: Documenting a project

[DpadamsX]

• documentation.md

Great stuff! MarkDown is fantastic, and 4D's support seems quite nice.

A couple of glitches:

• There's a typo : "For more information, see the GitHug Markdown guide".

• I cannot reproduce the described behavior for a # Description line in 18 R5 MacOS. Instead of an auto-generated prototype and my first sentence, I get the prototype only. Here's a basic example:

# Description
**DescriptionH1** (Text; Longint) : Text

I've tried ## Description instead, and have tried to put an extra CR after the end. No difference.

• With no documentation, the hover text has an extra blank line.

Other ideas:

Method_GetPrototype (Method name) : Text that you display in the hover now.

Sounds like you're supporting overloading (pure evil). If so

Method_GetPrototypes (Method name) : Collection of texts that you display in the hover for some obects now.

Better:

*Method_GetParameters (Method name) : Collection

For the moment, parameters only have the attributes # and label (using the def system). The options would be a lot richer and better with a few more attributes on def:

• required a Boolean.
• default listing default value, when parameter is not included.
• allowed if you've got an allowed list or range.
• excluded if you've got an excluded list or range.
• check/rule if you support it. Would be nice to have a range/series/value check rule implemented in the declaration as an in-line rule, or via a function call.

[arnaud4d]

Hello, thank you for reporting the typo, it has been fixed.

Please post feature requests on the dedicated 4d forum, where they will be registered properly.

Thank you