From 54efe75b0b8bfecec95c78fdd34aebeec0efd631 Mon Sep 17 00:00:00 2001 From: Erik Schierboom Date: Thu, 28 Jan 2021 14:12:05 +0100 Subject: [PATCH] Convert example to exemplar * Rename example files to exemplar See https://github.com/exercism/v3-docs/pull/23 * [Docs] Correct .meta/example references to .meta/exemplar * [Docs] Use exemplar instead of example * [Docs] Update example name in file listings * [Julia] Convert to exemplar.jl * [elm] Rename .meta/Cook.elm to .meta/Examplar.elm * [elm] Rename .meta/Examplar.elm .meta/Exemplar.elm Co-authored-by: Matthieu Pizenberg --- .../.meta/{example.py => exemplar.py} | 0 .../currency-exchange/.meta/{example.py => exemplar.py} | 0 .../elyses-enchantments/.meta/{example.py => exemplar.py} | 0 .../.meta/{example.py => exemplar.py} | 0 .../guidos-gorgeous-lasagna/.meta/{example.py => exemplar.py} | 0 .../inventory-management/.meta/{example.py => exemplar.py} | 0 .../little-sisters-essay/.meta/{example.py => exemplar.py} | 0 .../concept/log-levels/.meta/{example.py => exemplar.py} | 0 .../making-the-grade/.meta/{example.py => exemplar.py} | 0 .../concept/pretty-leaflet/.meta/{example.py => exemplar.py} | 0 .../concept/processing-logs/.meta/{example.py => exemplar.py} | 0 .../restaurant-rozalynn/.meta/{example.py => exemplar.py} | 0 exercises/concept/sets/.meta/{example.py => exemplar.py} | 0 .../tisbury-treasure-hunt/.meta/{example.py => exemplar.py} | 0 reference/implementing-a-concept-exercise.md | 4 ++-- 15 files changed, 2 insertions(+), 2 deletions(-) rename exercises/concept/chaitanas-colossal-coaster/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/currency-exchange/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/elyses-enchantments/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/ghost-gobble-arcade-game/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/guidos-gorgeous-lasagna/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/inventory-management/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/little-sisters-essay/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/log-levels/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/making-the-grade/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/pretty-leaflet/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/processing-logs/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/restaurant-rozalynn/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/sets/.meta/{example.py => exemplar.py} (100%) rename exercises/concept/tisbury-treasure-hunt/.meta/{example.py => exemplar.py} (100%) diff --git a/exercises/concept/chaitanas-colossal-coaster/.meta/example.py b/exercises/concept/chaitanas-colossal-coaster/.meta/exemplar.py similarity index 100% rename from exercises/concept/chaitanas-colossal-coaster/.meta/example.py rename to exercises/concept/chaitanas-colossal-coaster/.meta/exemplar.py diff --git a/exercises/concept/currency-exchange/.meta/example.py b/exercises/concept/currency-exchange/.meta/exemplar.py similarity index 100% rename from exercises/concept/currency-exchange/.meta/example.py rename to exercises/concept/currency-exchange/.meta/exemplar.py diff --git a/exercises/concept/elyses-enchantments/.meta/example.py b/exercises/concept/elyses-enchantments/.meta/exemplar.py similarity index 100% rename from exercises/concept/elyses-enchantments/.meta/example.py rename to exercises/concept/elyses-enchantments/.meta/exemplar.py diff --git a/exercises/concept/ghost-gobble-arcade-game/.meta/example.py b/exercises/concept/ghost-gobble-arcade-game/.meta/exemplar.py similarity index 100% rename from exercises/concept/ghost-gobble-arcade-game/.meta/example.py rename to exercises/concept/ghost-gobble-arcade-game/.meta/exemplar.py diff --git a/exercises/concept/guidos-gorgeous-lasagna/.meta/example.py b/exercises/concept/guidos-gorgeous-lasagna/.meta/exemplar.py similarity index 100% rename from exercises/concept/guidos-gorgeous-lasagna/.meta/example.py rename to exercises/concept/guidos-gorgeous-lasagna/.meta/exemplar.py diff --git a/exercises/concept/inventory-management/.meta/example.py b/exercises/concept/inventory-management/.meta/exemplar.py similarity index 100% rename from exercises/concept/inventory-management/.meta/example.py rename to exercises/concept/inventory-management/.meta/exemplar.py diff --git a/exercises/concept/little-sisters-essay/.meta/example.py b/exercises/concept/little-sisters-essay/.meta/exemplar.py similarity index 100% rename from exercises/concept/little-sisters-essay/.meta/example.py rename to exercises/concept/little-sisters-essay/.meta/exemplar.py diff --git a/exercises/concept/log-levels/.meta/example.py b/exercises/concept/log-levels/.meta/exemplar.py similarity index 100% rename from exercises/concept/log-levels/.meta/example.py rename to exercises/concept/log-levels/.meta/exemplar.py diff --git a/exercises/concept/making-the-grade/.meta/example.py b/exercises/concept/making-the-grade/.meta/exemplar.py similarity index 100% rename from exercises/concept/making-the-grade/.meta/example.py rename to exercises/concept/making-the-grade/.meta/exemplar.py diff --git a/exercises/concept/pretty-leaflet/.meta/example.py b/exercises/concept/pretty-leaflet/.meta/exemplar.py similarity index 100% rename from exercises/concept/pretty-leaflet/.meta/example.py rename to exercises/concept/pretty-leaflet/.meta/exemplar.py diff --git a/exercises/concept/processing-logs/.meta/example.py b/exercises/concept/processing-logs/.meta/exemplar.py similarity index 100% rename from exercises/concept/processing-logs/.meta/example.py rename to exercises/concept/processing-logs/.meta/exemplar.py diff --git a/exercises/concept/restaurant-rozalynn/.meta/example.py b/exercises/concept/restaurant-rozalynn/.meta/exemplar.py similarity index 100% rename from exercises/concept/restaurant-rozalynn/.meta/example.py rename to exercises/concept/restaurant-rozalynn/.meta/exemplar.py diff --git a/exercises/concept/sets/.meta/example.py b/exercises/concept/sets/.meta/exemplar.py similarity index 100% rename from exercises/concept/sets/.meta/example.py rename to exercises/concept/sets/.meta/exemplar.py diff --git a/exercises/concept/tisbury-treasure-hunt/.meta/example.py b/exercises/concept/tisbury-treasure-hunt/.meta/exemplar.py similarity index 100% rename from exercises/concept/tisbury-treasure-hunt/.meta/example.py rename to exercises/concept/tisbury-treasure-hunt/.meta/exemplar.py diff --git a/reference/implementing-a-concept-exercise.md b/reference/implementing-a-concept-exercise.md index 5360f19e98..d627946feb 100644 --- a/reference/implementing-a-concept-exercise.md +++ b/reference/implementing-a-concept-exercise.md @@ -41,7 +41,7 @@ languages ├── .meta | ├── config.json | ├── design.md - | └── example.py + | └── exemplar.py ├── .py └── _test.py @@ -57,7 +57,7 @@ These are files specific to the Python track, and can be added in any order: - `/_test.py` The test suite a submitted solution will be tested against. Tests should be written using [`unittest.TestCase`][unittest] ([example test file][example-testfile]). We do use PyTest as our test runner, but please check with a maintainer before using any PyTest-specific methods. -- `.meta/example.py` +- `.meta/exemplar.py` An idiomatic implementation that passes all the provided tests. This solution file should only use **syntax & concepts introduced in the concept exercise itself, or one of its prerequisites.**. This means avoiding the use of `classes`, `comprehensions`, `generators`, `slice assignment`, `regex`, `filter/map/reduce`, standard library modules (_like `datetime`_), or 3rd-party libraries unless the exercise has introduced these concepts or they appear in the exercise's prerequisite tree. Please follow the [PEP8][pep8] formatting guidelines. Additionally, we'd like you to avoid any single-letter or cryptic variable names. ## Step 2: Add exercise documentation files