astral-sh / ruff

An extremely fast Python linter and code formatter, written in Rust.

Home Page:https://docs.astral.sh/ruff

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

`cargo install ruff` links to a non-existent link now

DeflateAwning opened this issue · comments

When you run cargo install ruff, it links to https://github.com/charliermarsh/ruff#installation-and-usage, with an error message saying that it can't be installed from Cargo.

That's all fine.

The link should be updated to https://github.com/charliermarsh/ruff#installation, though.

I can update the link.

@charliermarsh was this fixed? Although I don't see that link in the output of cargo install ruff:

    Updating crates.io index
  Downloaded ruff v0.0.1
  Downloaded 1 crate (1.7 KB) in 1.78s
  Installing ruff v0.0.1
    Updating crates.io index
   Compiling ruff v0.0.1
error: Ruff is not yet available on crates.io. See https://github.com/astral-sh/ruff for alternative installations instructions.
 --> /Users/dhruv/.cargo/registry/src/index.crates.io-6f17d22bba15001f/ruff-0.0.1/main.rs:1:1
  |
1 | compile_error!("Ruff is not yet available on crates.io. See https://github.com/astral-sh/ruff for alternative installations instructions.");
  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: could not compile `ruff` (bin "ruff") due to 1 previous error
error: failed to compile `ruff v0.0.1`, intermediate artifacts can be found at `/var/folders/0h/7pwtlzd924l7ydmq5kwvd2dc0000gn/T/cargo-installXsXN
BZ`.
To reuse those artifacts with a future compilation, set the environment variable `CARGO_TARGET_DIR` to that path.

Yes, I updated the link to point to astral-sh and removed the hash which could change across versions.

Ah too bad, that hash to the installation section made it clear what the correct way to install is. Without it, I'd suggest that the error message would probably be better if it read Cargo not supported yet. Please install with "pip install ruff".

Regardless, doesn't really matter I suppose.