Skip to content

Improve readability of commands, but support both bash and windows formatting #1051

Description

@TimMonko

Consider reformatting for readability:

uv pip compile \
  --python-version 3.12 \
  --output-file resources/constraints/constraints_py3.12.txt \
  --extra pyqt6 \
  --extra pyside6 \
  --extra testing \
  --extra all_optional \
  --group testing_extra \
  --exclude resources/constraints/napari_exclude.txt \
  pyproject.toml \
  resources/constraints/version_denylist.txt

Originally posted by @willingc in #1043 (comment)

I completely agree, unfortunately this formatting only works on Unix-type shells
On windows its either ` (powershell) or ^ (cmd/batch) to do multi-line formatting.

When I started, bash was something that totally screwed me up and was part of the contribution guide to run the docs. I'd like to avoid requiring bash but I also would like a solution that maybe we have the little tabs that default to bash formatting but also show powershell (I think this is most common use case these days on windows). That or we strongly emphasize how bash works in our docs and how to get started on windows. Of course this should be a follow-up discussion so I'm going to merge this as is, for now

Originally posted by @TimMonko in #1043 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions