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.

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

Document the feedback functionality #28

Open
oleks opened this issue Apr 10, 2020 · 1 comment
Open

Document the feedback functionality #28

oleks opened this issue Apr 10, 2020 · 1 comment
Assignees

Comments

@oleks
Copy link
Member

oleks commented Apr 10, 2020

The parsec parser does allow to provide a "Feedback judgement" like this:

# Assignment 1: 10/10
## Feedback:
  * Good work!
## Task 1: 10/10

Then, we can extract the feedback using the CLI:

$ remarks feedback remarks.mrk
# Assignment 1

  * Good work!

However, the README makes no mention of Feeedback judgements, while still mentioning the feedback CLI command, which yields nothing if no Feedback judgements are present.

My immediate questions are:

  1. Is it supposed to be allowed that you have multiple Feedback judgements in a remarks document? (That would make sense under the original design.)
  2. Is a Feedback judgement supposed to be placed at the top of a judgement, above some other other sub-judgements?
  3. Is it intended that there can be multiple Feedback judgements under the same judgement?

Wrt. question 1, remarks currently does accept the following:

# Assignment 1: 0/10
## Feedback:
  * Good work!
## Task 1: 10/10
# Assignment 2: 0/10
## Feedback:
  * Bad work :-(
## Task 1: 0/10

However, it yields:

$ remarks feedback remarks.mrk
# Assignment 1

  * Good work!# Assignment 2
              
                * Bad work :-(

Which is not ideal ;-)

Wrt. question 2, the following yields a syntax error:

# Assignment 1: 0/10
## Feedback:
  * Good work!

In particular,

$ remarks feedback remarks.mrk
"remarks.mrk" (line 4, column 1):
unexpected end of input
expecting white space or "##"
@oleks
Copy link
Member Author

oleks commented Aug 6, 2024

@kirkedal Would be nice to clear this up 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants