Skip to content

Revamp the custom user functions documentation #1675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
petar-i-todorov opened this issue Apr 29, 2025 · 0 comments
Open

Revamp the custom user functions documentation #1675

petar-i-todorov opened this issue Apr 29, 2025 · 0 comments

Comments

@petar-i-todorov
Copy link
Contributor

Currently, when we point users to a solution that uses custom user functions, we typically provide the following documentation articles for guidance on how to add custom user functions:

However, I believe that the documentation for custom user functions should be more comprehensive and centralized, and effectively address common issues. For instance, there have been ticket cases in the past where users encounter difficulties adding custom user functions locally, even after reviewing the existing articles.

Consider applying the following changes:

  • Provide examples of how custom user functions can address real-life situations.
  • Clarify the distinction between custom user functions in the report class and those from a separate assembly. Consider emphasizing this difference in the section headings. It might also be helpful to mention these distinctions at the beginning of the article and include an unordered list with items pointing to the relevant sections (an example can be found here).
  • Cover some common caveats, such as the difference between the .NET/.NET Framework SRD version, and why it is important to use the correct one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant