Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: Null argument user command not supported in Jenny #3501

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Null argument user command not supported in Jenny #3501

wants to merge 2 commits into from

Conversation

spydon
Copy link
Member

@spydon spydon commented Feb 17, 2025

Description

Null arguments are not supported for user defined commands in Jenny, updated the docs accordingly.

Closes: #3500

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • I have updated/added relevant examples in examples or docs.

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 17, 2025 •
edited
Loading

Benchmark Results

Package flame:

Benchmarks Current Branch
[doc/jenny-null-not-supported]		 Base Branch
[main]		 Diff
Render Components Benchmark 962.503 μs 949.467 μs 🔴 +1.373 %
Updating Components Benchmark 336645.167 μs 333688.000 μs 🔴 +0.886 %

Benchmarks provided with 💙 by Dart Benchmark Action.

@livtanong
Copy link
Contributor

@spydon i think it would also be good to update the CommandStorage docs to explicitly state that nulls are not allowed https://docs.flame-engine.org/latest/other_modules/jenny/runtime/command_storage.html#

@spydon
Copy link
Member Author

spydon commented Feb 17, 2025

@spydon i think it would also be good to update the CommandStorage docs to explicitly state that nulls are not allowed https://docs.flame-engine.org/latest/other_modules/jenny/runtime/command_storage.html#

It does explicitly list which types that are allowed already, and nullable types are not listed:

The function’s arguments must be of types that are known to Yarn: String, num, int, double, or bool. All arguments must be positional, with no defaults.

@spydon
Copy link
Member Author

spydon commented Feb 17, 2025

@livtanong added a short note about it in abdb503 anyways, so that it is completely clear to the user.

@spydon spydon requested a review from erickzanardo February 18, 2025 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erickzanardo erickzanardo Awaiting requested review from erickzanardo

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Jenny documentation about User-defined commands does not match actual behavior
2 participants
@spydon @livtanong