Improve Concept Exercise: Elyses Enchantments (`arrays`)
See original GitHub issueRelated: https://github.com/exercism/support/issues/28#issuecomment-926606144
This is a tiny task. The stubbed JSDoc can be improved.
Current JSDoc
/**
* Remove the card at the 0-based position
*
...
*/
Proposal
Change this JSDoc to make it clear that the card at the given position must be removed. Perhaps we say: position 0 is the first position
or something like that. 0-based and 1-based indexation isn’t a concept that’s necessarily clear, so making it more easy to discover might help future students.
Issue Analytics
- State:
- Created 2 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
Improve Concept Exercise: Elyses Transformative ... - GitHub
The goal of this task is to make sure the Concept Exercise "Elyses Transformative Enchantments" conform to the latest specification.
Read more >Elyse's Enchantments | Exercism's Docs
This story can be continued to also teach array transformations: Double every single card; Create multiple copies of every 3 found in the...
Read more >Untitled
Top gear series 21 episode 3 part 2, 90s dress up ideas. ... T7500 processor upgrade, Haemonetics cell saver 5, Gauthier destenay linkedin?...
Read more >dSu - River Thames Conditions - Environment Agency - GOV.UK
Save yourself for my darkest days, Taisez vous definition, Prkna na podlahu ... Kapaza belgie meubelen huisdecoratie, Pilates reformer pregnancy exercises?
Read more >Untitled
Hltv models cs 1.6, Diy playhouse ideas, Google founded in 1996, ... Imo 659e, Antenna for modem bolt, Php slash in url, Done...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I’d like to work on this
@pertrai1 Thanks for offering to help! First of all please note that this issue is just about clarifying the JSDoc and the exercise instructions with regards to the
position
parameter. (I made a typo in my comment above by writing “introduction”, sorry for that.)There is another ticket for fixing the introduction: https://github.com/exercism/javascript/issues/1339
Someone already volunteered for this but since there was no activity for a while feel free to ask there whether you can take over the task.
Now to your question regarding the comments in the examples. Usually we would give the explanation in the text and then the example is really just the example. Otherwise it can get confusing what information is given in the text vs. the comments of the example (or one is more or less a duplicate of the other). Of course there are some special cases where a comment is needed but that’s rather an exception than the rule. Have a look here for an example of the system I described https://github.com/exercism/javascript/blob/main/concepts/objects/introduction.md#retrieving-a-value