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

Update glossary.yml #36

Merged
merged 12 commits into from
Jul 13, 2020
76 changes: 73 additions & 3 deletions data/glossary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
## ```

- term: Abandoned kata
description: Kata whose the author is not active anymore.
description: |
Kata whose the author is not active anymore.

- term: Active (author)
description: Author who has been connected to Codewars during the last 30 days.
Expand All @@ -55,6 +56,25 @@
- term: Beta (kata/process)
description: The beta process is the phase where a kata is visible to any other user in the database/[katas search page](https://www.codewars.com/kata/my-languages) but does not have a rank yet. It is to be tested by other users, so that it can be enhanced, modified, ranked and finally approved... or retired if not qualitative enough.

- term: Clan(s)
description: |
You can write the name of your clan/company/organization through your `profile/account settings` page. All the members of this clan are automatically recognized as allies of yours, hence are added to your personnal leaderboard in the dashboard.
links:
- title: Dashboard leaderboard
url: https://www.codewars.com/dashboard

- term: Collections(s)
description: |
Collections are sets or libraries of katas that any user can create, for any purpose. All collections are public.
links:
- title: Collections created by one user
url: https://www.codewars.com/users/Blind4Basics/authored_collections
- title: Browse through all collections
url: https://www.codewars.com/collections

- term: Console
description: Synonym for "output panel" (see below).

- term: Contributor(s)
description: User(s) who have either authored, approved, translated or modified a kata in any way (a list of them can be seen in the "Details" page of any kata.

Expand Down Expand Up @@ -99,10 +119,19 @@
- term: Forfeit (a kata)
description: |
You forfeit a kata when you do one of those actions:
* you unlock the solutions (through the button in the trainer, for example)
* you enter the edit panel (_warning_: power users may have the possibility to enter the edit panel of some katas. If you do so before you solved it, you actually forfeit it).
* You unlock the solutions (through the button in the trainer, for example)
* You enter the edit panel (_warning_, power users may have the possibility to enter the edit panel of some katas. If you do so before you solved it, you actually forfeit it).
Forfeiting a kata makes you lose the opportunity to gain honor points or progress by completing this kata.

- term: Fork
description: |
In the solutions page of a kata, you can see the solutions of other users, and you can `fork` them to suggest modifications/enhancements (button below each solution).
Using the fork panel is the right way to try out a solution of another user, rather than to copy it in the trainer of the kata.

- term: Honor (points)
description: |
Honor points are the score that is showing up in the top right corner, aside of your avatar. You can win honor points in different ways (completing katas, up votes on your comments or solutions, translations, creating katas, ...)

- term: Inactive (author)
description: |
Author of a kata who hasn't been connected for more than 30 days. When an author is inactive, some actions he's normally the only person allowed to do are doable by other people (power users with the required privilegees).
Expand Down Expand Up @@ -138,6 +167,47 @@
- title: Kyū - Wikipedia
url: https://en.wikipedia.org/wiki/Ky%C5%AB

- term: Language versions
description: |
A kata may be available in one or more languages (javascript, python, coq, ...), and for each language there may be different versions like Node 8 or Node 10 for JS, python 3.4.3 or 3.6, ... You can choose the language _and_ the language version in the trainer of a kata (amongst the available ones only).

- term: Leaderboards
description: Leaderboards are grouping different users according to different criteria.
links:
- title: Overall top 500
url: https://www.codewars.com/users/leaderboard
- title: Top 500 by completed Katas
url: https://www.codewars.com/users/leaderboard/kata
- title: Top 500 by authored Katas and translations
url: https://www.codewars.com/users/leaderboard/authored
- title: Your personnal leaderboard (with your allies, in the dashboard)
url: https://www.codewars.com/dashboard

- term: Markdowns (formatting)
description: |
CodeWars is responsive to `markdowns`. They allow you to format code, descriptions or comments so that thay are properly readable for other users.

- term: Merge conflicts
description: |
When a translation of a kata is published but some changes are done to the description (through the edit panel) before the translation gets approved, it becomes impossible to approve it because of those "merge conflicts".
To resolve this problem, you have to fork the translation and update the description starting with its current (new) version.

- term: Mutation of the input
description: |
To keep it short...: ___Don't mutate the input... Ever___ (eg. don't use sort, append, push, remove, ... and alike before doing a copy of the input).
This is about side effects, modifying the arguments (typically lists/arrays, or even strings if they are mutable in your language) sent to your function during the executions. This can have weird consequences, depending on how the tests are written.
Nowadays, most test suites are written in a way that avoids this kind of problem but typically, if you end up passing the fixed tests but failing all the random tests with something along the line of `[your result] should equal []`, you're most likely facing a "mutation of the input" problem.
Hence... Don't mutate the input.

- term: Preloaded (code/section)
description: |
In a Kata, the preloaded section is code that is executed _before_ the solution of the user is defined. The code hold by this section isn't visible to the user but every function or variable defined there is accessible to him drugint the executions of his code.
If you need/want to see the preloaded section of a Kata, open a fork of a solution _after_ you solved it and look to the `Preloaded` panel.

- term: Progress
description: |
Aside of honor points, you gain "progress" by completing Katas (and only that way). Progess is what is conditioning your current rank as a codewarrior.

- term: Publishing (kata)
description: When you hit "publish" in the edit panel of a kata you created, it enters the beta process and becomes visible to anyone in the [katas search page](https://www.codewars.com/kata/my-languages). The beta process begins at the moment a kata is published.

Expand Down