diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 212cfc67c4..835c0e5dc4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,8 @@ It's not uncommon that people discover incorrect implementations of certain test We welcome contributions of all sorts and sizes, from reporting issues to submitting patches, as well as joining the current [discussions 💬][issue-discussion]. -> :warning: This guide is slightly outdated and doesn't hold the V3 changes yet. +> [!WARNING] +> This guide is slightly outdated and doesn't hold the V3 changes yet. --- @@ -209,7 +210,8 @@ It then interactively gives the maintainer the option to include or exclude test We have various `scripts` to aid with maintaining and contributing to this repository. -> ⚠ If you encounter the following error: +> [!IMPORTANT] +> If you encounter the following error: > > ```text > SyntaxError: Unexpected token 'export' diff --git a/README.md b/README.md index 7ed9a99e58..99fb14e61d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,10 @@ [![Configlet](https://github.com/exercism/javascript/actions/workflows/configlet.yml/badge.svg)](https://github.com/exercism/javascript/actions/workflows/configlet.yml) [![javascript / main](https://github.com/exercism/javascript/workflows/javascript%20/%20main/badge.svg)](https://github.com/exercism/javascript/actions?query=workflow%3A%22javascript+%2F+main%22) -⚠️ We 💙 our community but **this repository does not accept community contributions at this time**. -There are no active maintainers to review PRs. -Please read this [community blog post][freeing-maintainers] for details. ⚠️ +> [!IMPORTANT] +> We 💙 our community but **this repository does not accept community contributions at this time**.
+> There are no active maintainers to review PRs.
+> Please read this [community blog post][freeing-maintainers] for details. **Exercism exercises in JavaScript** diff --git a/docs/FUNCTIONS.md b/docs/FUNCTIONS.md index 4c086fa08e..a313df3c18 100644 --- a/docs/FUNCTIONS.md +++ b/docs/FUNCTIONS.md @@ -6,7 +6,8 @@ In JavaScript, functions are _first class objects_ which means they can be assig JavaScript functions allow you to pass arguments when they are called. Arguments are always [passed by value](https://dev.to/xpbytes/javascript-ruby-and-c-are-not-call-by-reference-23f7). In other words, if a function reassigns a parameter inside the function, the value won't change outside the function. That doesn't mean that passed-in objects cannot be mutated. -> 💡 When an object is passed in, the reference to that object is passed in by value. This makes it _seem_ like passing in objects are handled differently, but that's not the case. +> [!TIP] +> When an object is passed in, the reference to that object is passed in by value. This makes it _seem_ like passing in objects are handled differently, but that's not the case. An example of a function that takes two arguments and multiplies them is: diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 0767f1b780..a32eab521c 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -48,11 +48,12 @@ After the installer is done, or the package manager has completed, or the binary The version should match the one on the website. -**Note**: It is important to open a _new_ terminal window. -Any open terminal windows might not have been refreshed after the installation completed. -This means that the open terminals don't know that a new program was installed. +> [!NOTE] +> It is important to open a _new_ terminal window. +> Any open terminal windows might not have been refreshed after the installation completed. +> This means that the open terminals don't know that a new program was installed. -> _**Help**_: `'node' is not recognised` +> [!IMPORTANT] > _**Help**_: `'node' is not recognised` > > If you've used the official installer, your `PATH` should have been automatically configured, but if your shell has trouble locating your globally installed modules — or if you build Node.js from source — update your `PATH` to include the `npm` binaries. > @@ -86,7 +87,7 @@ They can be installed running this command within each assignment directory: npm install ``` -> _**Help**_: `'' is missing / cannot be found` +> [!IMPORTANT] > _**Help**_: `'' is missing / cannot be found` > > If you see this after _upgrading_ your exercise, welcome to npm 7. > Delete `node_modules` and `package-lock.json` and re-run the command to resolve this. diff --git a/reference/implementing-a-concept-exercise.md b/reference/implementing-a-concept-exercise.md index 778eae9f6d..0d7a76bdf4 100644 --- a/reference/implementing-a-concept-exercise.md +++ b/reference/implementing-a-concept-exercise.md @@ -61,7 +61,8 @@ github/exercism The configuration files may be copied from another exercise. We aim to keep these in sync: -> ⚠ Just like with _practice_ exercises, we will provide a script for you to run. This script needs to be updated from its v2 version, which has not yet been done. +> [!WARNING] +> Just like with _practice_ exercises, we will provide a script for you to run. This script needs to be updated from its v2 version, which has not yet been done. - `.eslintrc` - `.gitignore` diff --git a/reference/info/concurrency.md b/reference/info/concurrency.md index 966f795769..f7bf218494 100644 --- a/reference/info/concurrency.md +++ b/reference/info/concurrency.md @@ -1,9 +1,8 @@ # Concurrency -> When people hear the word _concurrency_ they often think of _parallelism_, a related but quite distinct concept. -> In programming, concurrency is the _composition_ of independently executing processes, while parallelism is the -> _simultaneous execution_ of (possibly related) computations. -> [Concurrency is not parallelism](https://blog.golang.org/concurrency-is-not-parallelism) +> [!NOTE] +> When people hear the word _concurrency_ they often think of _parallelism_, a related but quite distinct concept.
+> In programming, concurrency is the _composition_ of independently executing processes, while parallelism is the
> _simultaneous execution_ of (possibly related) computations.
> [Concurrency is not parallelism](https://blog.golang.org/concurrency-is-not-parallelism) See also [Event loop][concept-event-loop]. diff --git a/reference/info/event_loop.md b/reference/info/event_loop.md index cd11078717..074d7a99b4 100644 --- a/reference/info/event_loop.md +++ b/reference/info/event_loop.md @@ -1,6 +1,6 @@ # Event loop -> [JavaScript][language-javascript] has a concurrency model based on an event loop, which is responsible for executing the code, collecting and processing events, and executing queued sub-tasks. This model is quite different from models in other languages like [C][language-c] and Java. +> [!NOTE] > [JavaScript][language-javascript] has a concurrency model based on an event loop, which is responsible for executing the code, collecting and processing events, and executing queued sub-tasks. This model is quite different from models in other languages like [C][language-c] and Java. [language-c]: https://github.com/exercism/v3/blob/main/c/README.md [language-javascript]: ../../README.md diff --git a/reference/info/falsy.md b/reference/info/falsy.md index c16e85c9d2..6c0db4e421 100644 --- a/reference/info/falsy.md +++ b/reference/info/falsy.md @@ -4,6 +4,7 @@ A falsy value is a value that is considered `false` when encountered in a [Boole [JavaScript][language-javascript] uses [Type Conversion][concept-type-coercion] to coerce any value to a [Boolean][type-boolean] in contexts that require it, such as [conditionals][concept-conditionals] and [loops][concept-loops]. +> [!NOTE] > There are 7 falsy values in JavaScript. > > This means that when JavaScript is expecting a boolean and it is given one of the values below, it will always evaluate to "falsy".