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

Define tutorial requires using give but that command has not yet been explained by the tutorial #1086

Closed
byorgey opened this issue Feb 5, 2023 · 0 comments · Fixed by #1249
Closed

Define tutorial requires using give but that command has not yet been explained by the tutorial #1086

byorgey opened this issue Feb 5, 2023 · 0 comments · Fixed by #1249
Labels
Bug The observed behaviour is incorrect or unexpected. C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. T-Tutorial Involves the tutorial experience for new players.

Comments

@byorgey
Copy link
Member

byorgey commented Feb 5, 2023 •
edited

The give command does technically show up in the Debug tutorial, but you are simply told to execute give base "Win"; it is not really explained. Since this command is needed to solve the Define tutorial, we should add a paragraph explaining it.
@byorgey byorgey added the Bug The observed behaviour is incorrect or unexpected. label Feb 5, 2023
@byorgey byorgey mentioned this issue Feb 6, 2023
Closed
@kostmo kostmo mentioned this issue Mar 29, 2023
Merged
@byorgey byorgey added T-Tutorial Involves the tutorial experience for new players. C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. labels Apr 1, 2023
mergify bot pushed a commit that referenced this issue Apr 3, 2023
@kostmo
Dump a list of tutorials and commands they first introduce (#1186)
65e3f2b 
May be able to reduce likelihood of #1086 by having a autogenerated table of the commands and the tutorials they are introduced in.

This work is related to #1106 in that robot commands should be given distinct markup (backticks).

## Demo

    scripts/play.sh generate pedagogy

**Updated:** See [rendered output](https://gist.github.com/kostmo/d4af3a6814e65fc6d455fd34b41552d3).

## New tests

    scripts/run-tests.sh --test-arguments '--pattern "Pedagogical soundness"'

Note that the test for `crash.yaml` is currently failing because the `Give` command (and some others) are utilized in this tutorial without having been mentioned in the description or in earlier tutorials.

Additionally, the "bug" described in [this comment](#1089 (comment)) **should** be caught by these tests (i.e. fail the tests) since the embedded `solution` code in the YAML file utilizes the `give` command.  That is, if it currently weren't for [this issue](https://github.com/swarm-game/swarm/pull/1186/files#r1152789153).
byorgey added a commit that referenced this issue May 10, 2023
@byorgey
add new give tutorial
ef4e0dc 
Fixes #1086.
@byorgey byorgey mentioned this issue May 10, 2023
Merged
@mergify mergify bot closed this as completed in #1249 May 12, 2023
mergify bot pushed a commit that referenced this issue May 12, 2023
@byorgey
add new give tutorial (#1249)
305867a 
Fixes #1086.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug The observed behaviour is incorrect or unexpected. C-Low Hanging Fruit Ideal issue for new contributors. S-Moderate The fix or feature would substantially improve user experience. T-Tutorial Involves the tutorial experience for new players.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add new give tutorial swarm-game/swarm
1 participant
@byorgey