mitmath / mitmath/JuliaComputation

Improvements to HW1a (Pokémon)

Open
#3 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
110
Forks
16
PR merge metrics
No merged PRs in 30d

Description

  • Invite students to use the documentation (? in the REPL / docs tab in Pluto)
  • Present intro tutorial before the homework
  • Say that just because checks are passing doesn't mean the answer is correct
  • Add question numbers
  • Explain what an empty struct means + how to compare mutable and immutable structs (== vs ===)
  • Clarify inner / outer constructors
  • Note on matrix indexing to prevent them from using linear indices
  • Give a reference for various kinds of type dispatch syntax (f(x::X) vs f(x::Y) where {Y<:X})
  • Specify expected output for attack(::Corgi, ::Pokemon), and state that we do not accept catch-all methods (code should rely on dispatch instead)
  • Define what we mean by method ambiguity and explicitly lead students to find and resolve it
  • Fix check_defense_philip check
  • Explain how boundaries should be handled in the step! function
  • Make it clear that the attacker cannot attack itself

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating HW1a (Pokémon) and the referenced REPL and Pluto documentation material in the repository. Review each checklist item, including check_defense_philip and step!, and verify that the assignment’s expected outputs, dispatch guidance, indexing, constructor explanations, and boundary rules agree. Done means every checkbox is addressed and the homework instructions and checks are consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
content, documentation, testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.