Skip to content

Allow spin to run in sub-directories/easier to spot that your error is caused by being in a sub-directory #230

@betatim

Description

@betatim

Sometimes I am in a sub-directory of my repository and run spin doc (or some other command).

Currently this fails:

$ spin docs --no-plot
Error: need valid configuration in [.spin.toml], [spin.toml], or [pyproject.toml]
See https://github.com/scientific-python/spin/blob/main/README.md

Usage: spin [OPTIONS] COMMAND [ARGS]...
Try 'spin --help' for help.

Error: No such command 'docs'.

In the first instance this makes me think "ah, it must be doc not docs", which also fails. Mostly because I only read the "No such command" part of the output.

Two ideas:

  1. what about making it so that spin works from any sub-directory, like git?
  2. can we have spin exit after printing the first two lines? That seems like the message people should read and the usage info + "no such command" output is a distraction/red herring.

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