Skip to content

Incorrect (likely outdated) dependency installation instructions #752

Description

@JiriGuthJarkovsky

Priority

Medium

Responsible

No response

Type of Documentation Change

Existing documentation incorrect

Affected Page / Section

https://qrisp.eu/reference/Development%20Guide/getting_started.html#environment-setup

Short Description

Optional dependency test doesn't exist. Maybe it meant dev or dev-testing.

Long Description

The guide in "Getting Started", section "Environment setup" talks about the different optional dependency groups, but it appears outdated. It mentions test, but in the pyproject.toml file, there is no test group. Instead there are groups: dev-code-style, dev-testing and dev.

This is my first Issue, so I hope I'm doing things correctly.

Definition of Done

  • Documentation written / updated
  • Peer-reviewed for technical accuracy
  • Code examples tested and working
  • Renders correctly (checked locally or in preview)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions