search

Limpan / parsons-puzzle

MIT License
1 stars 0 forks source link

What is a puzzle? #11

Open Limpan opened 7 years ago

Limpan commented 7 years ago

A puzzle (sometimes synonymous to problem) should be handled like this.

Greenheart commented 7 years ago

Strip comments? What to you mean with this?

Since we use a DB, instructions could be stored as a separate field. This would allow for better presentation in the GUI.

You could of course regex the docstring out of the challenge seed code, but then why not just store the description as it's own field?

Limpan commented 7 years ago

Clarification on stripping comments. Depending on the origin of the code inline comments might be useful or they might make the puzzle to easy or difficult. When the puzzle is added it should be easy to choose.

You could of course regex the docstring out of the challenge seed code, but then why not just store the description as it's own field?

That's what I meant. We should regex out the docstring and use as an initial value for instruction or description.

I feel that puzzles should be relatively comment-free. Mostly because it's not that clear exactly where comment should be placed.

Greenheart commented 7 years ago

Regarding docsstrings - why not use a separate DB field? Then we don't need to have a method for to extract comments.

Or are you thinking about a minimal Puzzle-UI where all of the challenge is presented in a code editor format?

måndag 12 december 2016 skrev Linus Törngren notifications@github.com:

Clarification on stripping comments. Depending on the origin of the code inline comments might be useful or they might make the puzzle to easy or difficult. When the puzzle is added it should be easy to choose.

You could of course regex the docstring out of the challenge seed code, but then why not just store the description as it's own field?

That's what I thought. We could regex out the docstring and use as an initial value for instruction or description.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Limpan/parsons-puzzle/issues/11#issuecomment-266360867, or mute the thread https://github.com/notifications/unsubscribe-auth/AF12KSGEjLefaern6yVpEpxwcfXqvByDks5rHPiggaJpZM4LJuzo .

Greenheart commented 7 years ago

Ok - so users get an option to activate inline comments as hints? If used, this could decrease the reward for the given challenge.

måndag 12 december 2016 skrev Linus Törngren notifications@github.com:

Clarification on stripping comments. Depending on the origin of the code inline comments might be useful or they might make the puzzle to easy or difficult. When the puzzle is added it should be easy to choose.

You could of course regex the docstring out of the challenge seed code, but then why not just store the description as it's own field?

That's what I thought. We could regex out the docstring and use as an initial value for instruction or description.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Limpan/parsons-puzzle/issues/11#issuecomment-266360867, or mute the thread https://github.com/notifications/unsubscribe-auth/AF12KSGEjLefaern6yVpEpxwcfXqvByDks5rHPiggaJpZM4LJuzo .

Limpan commented 7 years ago

Regarding docsstrings - why not use a separate DB field? Then we don't need to have a method for to extract comments. Or are you thinking about a minimal Puzzle-UI where all of the challenge is presented in a code editor format?

I'm thinking that we should store it in a separate db field. But I think it should be extracted on creation.

Ok - so users get an option to activate inline comments as hints? If used, this could decrease the reward for the given challenge.

Could be one way to do it. Initially we could make do with stripping them completely? There could be some kind of flexible hint system in the future?

Greenheart commented 7 years ago

Extracting the docsstring and line comments will be a good initial solution since this allows users to submit all information at once, while seeing how the different pieces will fit together.

Let's store the docsstring as a challenge.description and all line comments in the list challenge.hints.

Each hint need to know on which line it should be displayed and it's content. Also it might need to know how many points it takes to get the specific hint.

For now, let's just store the data - the hints are a future addition.

måndag 12 december 2016 skrev Linus Törngren notifications@github.com:

Regarding docsstrings - why not use a separate DB field? Then we don't need to have a method for to extract comments. Or are you thinking about a minimal Puzzle-UI where all of the challenge is presented in a code editor format?

I'm thinking that we should store it in a separate db field. But I think it should be extracted on creation.

Ok - so users get an option to activate inline comments as hints? If used, this could decrease the reward for the given challenge.

Could be one way to do it. Initially we could make do with stripping them completely? There could be some kind of flexible hint system in the future?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Limpan/parsons-puzzle/issues/11#issuecomment-266381552, or mute the thread https://github.com/notifications/unsubscribe-auth/AF12Kb0R6E_NkamasFHtZ7Np7DDZUxpYks5rHRR8gaJpZM4LJuzo .