[NU-1836] Adjust SpeL conversion docs

[lukasz-bigorajski]

Describe your changes

Checklist before merge

• Related issue ID is placed at the beginning of PR title in [brackets] (can be GH issue or Nu Jira issue)
• Code is cleaned from temporary changes and commented out lines
• Parts of the code that are not easy to understand are documented in the code
• Changes are covered by automated tests
• Showcase in dev-application.conf added to demonstrate the feature
• Documentation added or updated
• Added entry in Changelog.md describing the change from the perspective of a public distribution user
• Added MigrationGuide.md entry in the appropriate subcategory if introducing a breaking change
• Verify that PR will be squashed during merge

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and readability of the SpEL documentation.
  • Expanded sections on data types, implicit and explicit conversions.
  • Improved examples for filtering and transforming lists.
  • Updated conversion matrix for better understanding of type relationships.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the Spel.md document, which focuses on Spring Expression Language (SpEL) within the Nussknacker framework. The updates aim to enhance clarity and readability by rephrasing and restructuring existing content. Notable changes include the removal of redundant phrases and an expansion of the data types section to better differentiate between Java types and their representations in JSON and Avro formats. The explanations regarding implicit and explicit conversions have been refined, highlighting the availability of utility classes alongside built-in functions. Additionally, the conversion matrix has been updated for improved clarity. The document now features more structured examples, particularly in the sections on filtering and transforming lists, with clearer syntax for accessing elements and invoking methods. Overall, these changes are designed to improve the instructional quality of the document, facilitating a better understanding of SpEL concepts and functionalities.

Possibly related PRs

• [NU-1836] Add casting and conversions docs #7124: The changes in this PR also focus on enhancing the documentation related to type conversions in SpEL, which aligns with the main PR's updates on clarifying conversions and data types.

Suggested labels

docs

Suggested reviewers

• ZbyszekMM
• arkadius

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/scenarios_authoring/Spel.md (1)

271-275: Improve clarity of type conversion introduction

The introduction to type conversions could be more precise. Consider this revision:

-It is possible to convert from a type to another type and this can be done by implicit and explicit conversion.
+Types can be converted between different formats through either implicit or explicit conversions.

-Explicit conversions are available as built-in functions and utility classes.
+Explicit conversions are performed using built-in functions and utility classes.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 00fd152 and e775f93.

📒 Files selected for processing (1)

• docs/scenarios_authoring/Spel.md (3 hunks)

🔇 Additional comments (2)

docs/scenarios_authoring/Spel.md (2)

290-293: LGTM! Clear explanation of conversion function prefixes

The explanation of the different function prefixes (canBe, to, toOrNull) is well-structured and clear. Each prefix's behavior is accurately described, making it easy for users to understand when to use each type of conversion function.

---

307-307: LGTM! Good example of LocalDateTime conversion

The added example '2018-10-23T12:12:13'.to('LocalDateTime') is relevant and demonstrates a common use case for type conversion in date/time handling.