Skip to content

Commit

Permalink
Change example implementation to exemplar (#23)
Browse files Browse the repository at this point in the history
* Change example implementation to exemplar

* Update anatomy/tracks/concept-exercises.md

Co-authored-by: Jeremy Walker <[email protected]>

* Update anatomy/tracks/concept-exercises.md

Co-authored-by: Jeremy Walker <[email protected]>

Co-authored-by: Jeremy Walker <[email protected]>
  • Loading branch information
ErikSchierboom and iHiD authored Jan 28, 2021
1 parent 0c23374 commit 4ef28e2
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion anatomy/tracks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ csharp
| | ├── .meta
| | | ├── config.json
| | | ├── design.md
| | | └── Example.cs (track-specific)
| | | └── Exemplar.cs (track-specific)
| | ├── CarsAssemble.cs (track-specific)
| | ├── CarsAssemble.csproj (track-specific)
| | └── CarsAssembleTests.cs (track-specific)
Expand Down
11 changes: 6 additions & 5 deletions anatomy/tracks/concept-exercises.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Besides these files, the following three files must be present, but their file n

- Test suite: verify a solution's correctness.
- Stub implementation: provide a starting point for students.
- Example implementation: provide an idiomatic implementation that passes all the tests.
- Exemplar implementation: provide an idiomatic implementation that passes all the tests.

### Example

Expand All @@ -63,7 +63,7 @@ exercises
├── .meta
| ├── config.json
| ├── design.md
| └── Example.cs (example implementation)
| └── Exemplar.cs (exemplar implementation)
├── CarsAssemble.cs (stub implementation)
└── CarsAssemblyTests.cs (tests)
</pre>
Expand Down Expand Up @@ -347,14 +347,15 @@ class LasagnaTest < Minitest::Test
end
```

### File: example implementation
### File: exemplar implementation

**Purpose:** Provide an idiomatic implementation that passes all the tests.
**Purpose:** Provide the target implementation that a student should aim for.

- This implementation is the target code that we want a student to aim for.
- Mentors will be shown this code as the "target" when writing feedback
- The implementation should only use language features introduced by the exercise or its prerequisites (and their prerequisites, and so on).
- The example file is _not_ shown to the student when doing in-browser coding and is _not_ downloaded to the student's file system when using the CLI.
- The exemplar file is _not_ shown to the student when doing in-browser coding and is _not_ downloaded to the student's file system when using the CLI.
- The exemplar file will be shown to mentors when commenting on solutions or representations.

#### Example

Expand Down

0 comments on commit 4ef28e2

Please sign in to comment.