Known Bad Documentation Pages

[mitsuhiko]

Here a list of pages that need improvements in the documentation:

• [ ] Configuration Keys: https://rye-up.com/guide/config/#config-file

  It's just a TOML dump without much explanation of defaults, what they can be changed to or if other values (eg from pyproject.toml are also consulted)

• [ ] Toolchain Management

  This is all over the place in different places. It's not really explained how Rye selects the right toolchain and how the different keys interact. There is .python-version, there is the minimum requirement in the pyproject.toml, there is the global toolchain default. Then we have some logic on the pin command about relaxed vs precise pins etc.

[gabelluardo]

Idk if these count as bad pages as well or they are just leftovers, but all the pages in https://rye-up.com/guide/commands/self point to the fetch page.

I think it's for this https://github.com/mitsuhiko/rye/blob/08910bc9b3b7c72a3d3ac694c4f3412259161477/docs/guide/commands/self/completion.md?plain=1#L1 https://github.com/mitsuhiko/rye/blob/08910bc9b3b7c72a3d3ac694c4f3412259161477/docs/guide/commands/self/uninstall.md?plain=1#L1 https://github.com/mitsuhiko/rye/blob/08910bc9b3b7c72a3d3ac694c4f3412259161477/docs/guide/commands/self/update.md?plain=1#L1

[mitsuhiko]

@gabelluardo definitely. I fixed these now.