Skip to content
New issue

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

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

Already on GitHub? # to your account

Adding sample instructions property #259

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

Conversation

niels9001
Copy link
Contributor

@niels9001 niels9001 commented Mar 2, 2025

Moving the sample instructions to a dedicated property. Closes: #258

For now, showing this under an i button:

image

@nmetulev
Copy link
Member

nmetulev commented Mar 7, 2025

@zateutsch, would love your review here to ensure consistency

@@ -94,6 +94,7 @@ internal static partial class ScenarioCategoryHelpers
ScenarioType = ScenarioType.{{scenarioCategory.Key}}{{scenario.Key}},
Name = "{{scenario.Value.Name}}",
Description = "{{scenario.Value.Description}}",
Instructions = "{{scenario.Value.Instructions}}",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way this is setup, you would create an empty string, not a null string, but the type is defined as nullable in the Scenario class (in the SG project). Lets just make sure typing there is meaningful. It seems like this property shouldn't be null, so if it is we should fail, not write "". If, on the other hand, the type should be nullable (like how it is defined), the type in the main project should not be initialized as "", but rather with null.

Copy link
Contributor

@zateutsch zateutsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few edits, but I'm really just providing review to myself hahaha

niels9001 and others added 4 commits March 20, 2025 22:06
Co-authored-by: Zach Teutsch <88554871+zateutsch@users.noreply.github.com>
Co-authored-by: Zach Teutsch <88554871+zateutsch@users.noreply.github.com>
Co-authored-by: Zach Teutsch <88554871+zateutsch@users.noreply.github.com>
Co-authored-by: Zach Teutsch <88554871+zateutsch@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ENHANCEMENT] Introduce sample instructions
4 participants