Skip to content

Document the rock_paper_scissors Game #14

@eberjohns

Description

@eberjohns

This sub-issue focuses on creating comprehensive documentation for the newly added "Rock, Paper, Scissors" game. This includes both user-facing instructions and internal code documentation.

Specific Tasks:

  • Create rock_paper_scissors/instructions.md:
    • This file should provide clear, concise instructions on how to play the Rock, Paper, Scissors game.
    • Include details on how to run the game from the command line.
    • Briefly describe the game's rules and objective.
  • Add Code Documentation to rock_paper_scissors/rock_paper_scissors.py:
    • File-level docstring: Add a docstring at the very top of the file explaining the overall purpose of the script.
    • Function docstrings: For each function.
    • play_round, main), add a docstring that clearly explains:
    • In-line comments: Add comments within complex logic blocks or non-obvious sections of code to explain the "why" behind the implementation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions