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

Variables in help text #82

Closed
swashbuck opened this issue Feb 2, 2024 · 1 comment · Fixed by #84
Closed

Variables in help text #82

swashbuck opened this issue Feb 2, 2024 · 1 comment · Fixed by #84
Assignees
@swashbuck
Labels
bug documentation released

Comments

@swashbuck
Copy link
Contributor

Subject of the issue/

  1. In the AAT, the help text for _completionBody and feedback shows placeholder variables that can be used. The {{scoreAsPercent}} variable is missing from the list, although it's included in the README.md.

  2. README.md instructs the developer to use double squiggly braces:

It may make use of the following variables: `{{attemptsSpent}}`, `{{attempts}}`, `{{attemptsLeft}}`, `{{score}}`, `{{scoreAsPercent}}` and `{{maxScore}}`.

However, the AAT help shows a mix of double and triple braces:

This text is displayed only when more attempts remain. You can use the following variables: {{attemptsSpent}}, {{attempts}}, {{attemptsLeft}}, {{{score}}}, {{{maxScore}}}.

I think these should all be aligned to avoid confusion.
@swashbuck swashbuck added the bug label Feb 2, 2024
@swashbuck swashbuck self-assigned this Mar 4, 2024
@swashbuck swashbuck moved this from New to Assigned in adapt_framework: The TODO Board Mar 4, 2024
@swashbuck swashbuck mentioned this issue Mar 4, 2024
Merged
@swashbuck swashbuck moved this from Assigned to Needs Reviewing in adapt_framework: The TODO Board Mar 4, 2024
swashbuck added a commit that referenced this issue Mar 5, 2024
@swashbuck
Fix: Add scoreAsPercent to help text, remove unnecessary triple squig…
5ba4d1d 
…glies (fixes #82)
@github-project-automation github-project-automation bot moved this from Needs Reviewing to Recently Released in adapt_framework: The TODO Board Mar 5, 2024
github-actions bot pushed a commit that referenced this issue Mar 5, 2024
@semantic-release-bot
Chore(release): 5.2.1 [skip ci]
2118774 
## [5.2.1](v5.2.0...v5.2.1) (2024-03-05)

### Fix

* Add scoreAsPercent to help text, remove unnecessary triple squigglies (fixes #82) ([5ba4d1d](5ba4d1d)), closes [#82](#82)
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 5, 2024

🎉 This issue has been resolved in version 5.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@swashbuck swashbuck

Labels
bug documentation released
Projects
None yet
Milestone
No milestone
1 participant
@swashbuck