Games: Documentation And Static Analysis

Mix.install([
  {:jason, "~> 1.4"},
  {:kino, "~> 0.9", override: true},
  {:youtube, github: "brooklinjazz/youtube"},
  {:hidden_cell, github: "brooklinjazz/hidden_cell"}
])

Navigation

Games: Documentation & DocTesting

Document your existing Games project. Add documentation tests and examples where appropriate.

Ensure all tests pass.

Games: Typespecs

Add typespecs to your Games.RockPaperScissors and Games.Wordle modules. Each public function should have an associated @spec.

Games: Dialyzer

Add Dialyxir to your existing Games project. You should be able to verify the typespecs in your application by running the following command.

mix dialyzer

Ensure all checks pass and fix any dialyzer errors.

Games: Credo

Add Credo to your existing Games project.

You should be able to run credo with the following command. Ensure that all checks pass and fix any errors or credo suggestions.

mix credo

Games: ExDocs

Add ExDocs to your existing Games project.

Run the following command to generate project documentation. Re-run the command to update project documentation.

mix docs

Commit Your Progress

DockYard Academy now recommends you use the latest Release rather than forking or cloning our repository.

Run git status to ensure there are no undesirable changes. Then run the following in your command line from the curriculum folder to commit your progress.

$ git add .
$ git commit -m "finish Games: Documentation And Static Analysis exercise"
$ git push

We’re proud to offer our open-source curriculum free of charge for anyone to learn from at their own pace.

We also offer a paid course where you can learn from an instructor alongside a cohort of your peers. We will accept applications for the June-August 2023 cohort soon.

Navigation