Proposal to enhance EvalEx Documentation with dedicated function pages

[oswaldobapvicjr]

Hi everyone,

I've been using and contributing to EvalEx and appreciate its powerful capabilities. However, the documentation presents all functions on a single page containing just the name (basic syntax) and description. While this is functional, I believe we can improve the user experience by offering more detailed documentation for each function.

Proposal

I propose restructuring the Standard Functions section so that each function has its own dedicated page. This would allow users to quickly find:

• Function name and syntax
• Detailed description
• Parameters' descriptions
• Example of use

Benefits

• Easier navigation and readability
• More clarity on function behavior and usage
• Improved accessibility for both new and experienced users

Would the community and maintainers be open to this enhancement? I’d love to hear thoughts, suggestions, or potential challenges with implementing this idea. I'm also happy to contribute towards organizing and structuring these pages.

Looking forward to your feedback!

[uklimaschewski]

Hi,

Thanks for the suggestion and your contributions to EvalEx - really appreciate it!

I agree that the function docs could be more detailed, and your idea makes sense in terms of improving clarity and usability. That said, I’m a bit hesitant about creating a separate page for every single function. With the number of functions we have (and growing), that would make the docs harder to maintain and update over time.

Instead, how about a compromise? We keep all functions on a single page, but give each one its own section with a heading. That way, we can still include detailed info (syntax, parameters, examples), but without the overhead of managing dozens of pages. Deep-linking via anchors would still work too.

If you're up for it, I’d be happy to collaborate on reorganizing the page in that format.

Thanks again for starting this conversation!

Best,
Udo

[oswaldobapvicjr]

That works too. Here's a suggestion for detailing using the SWITCH function, for example:

SWITCH

Since: 3.3.0

The SWITCH function provides a way to compare one value against a series of possible values, and return a specific result based on the first matching value. It's similar to nested IF statements but can be more concise and easier to read for certain scenarios.

Syntax

SWITCH(expression, value1, result1, [value2-N, result2-N, ...], [default])

Parameters

Name	Description
expression	The value or expression that the function will compare against the provided list of values.
value1, result1, value2, result2, ...	Pairs of values, where the function checks if the expression matches the first value in each pair.
default	An optional default value to be returned if no matching value is found.

Examples

Consider the following pre-existing variables:

Variable	Value
weekday	1
country_code	BRA
status	x

And the following expressions:

Expression	Result
SWITCH(weekday, 1, "Sunday", 2, "Monday", 3, "Tuesday")	"Sunday"
SWITCH(country_code, "DEU", "Germany", "BRA", "Brazil")	"Brazil"
SWITCH(status, "a", "active", "s", "suspended", "unknown")	"unknown"

[uklimaschewski]

yes, that looks very good.

[oswaldobapvicjr]

Pull request #530 created with detailed sections for all Basic Functions.

[uklimaschewski]

Thank you very much for the pull request, this looks very good now. 👍