Skip to content

[Feature] Add "Python Basic Syntax" section to lower the entry barrier for beginners #3

@Maliketh875

Description

@Maliketh875

Description of the Feature

Currently, the documentation focuses primarily on data science libraries (NumPy, Pandas) and modeling applications. While this is excellent for students with some programming experience, zero-basis beginners (e.g., freshmen or non-CS majors) may struggle to follow the logic without a grasp of the fundamentals.

To make this project more inclusive and self-contained, I propose adding a dedicated section or module covering Python Basic Syntax.

Proposed Solution

I suggest adding a "Quick Start" or "Basics" chapter before the data analysis sections. This section should be concise (cheat-sheet style) rather than a full textbook approach.

Key topics to cover:

  • Data Types: Basic operations for int, float, str, list, and dict.
  • Control Flow: Syntax for if/elif/else, for loops, and while loops.
  • Functions: How to define functions using def, passing arguments, and return values.
  • I/O: Basic print() formatting and user input.

Target Audience

  • First-year undergraduate students.
  • Participants preparing for MCM/ICM or CUMCM with limited coding background.

Acceptance Criteria

The issue will be considered resolved when:

  • A new section/file regarding basic syntax is added to the documentation.
  • Code snippets for variables, loops, and functions are included.
  • The content follows the existing "pragmatic" style of the repository.

Additional Context

Since this project targets the 2026 competition cycle, ensuring the basics are covered will help users focus on the modeling logic rather than syntax errors during the actual competition.

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