Add some docs

crates/uv-cli/src/lib.rs

@@ -3702,26 +3702,26 @@ pub struct GenerateShellCompletionArgs {
 #[derive(Args)]
 #[allow(clippy::struct_excessive_bools)]
 pub struct IndexArgs {
-    /// The URL of the Python package index (by default: <https://pypi.org/simple>).
+    /// The URLs of packages indexes to use when resolving dependencies.
     ///
     /// Accepts either a repository compliant with PEP 503 (the simple repository API), or a local
     /// directory laid out in the same format.
     ///
-    /// The index given by this flag is given lower priority than all other
-    /// indexes specified via the `--extra-index-url` flag.
-    #[arg(long, env = "UV_DEFAULT_INDEX", value_parser = parse_default_index_source, help_heading = "Index options")]
-    pub default_index: Option<Maybe<IndexSource>>,
+    /// All indexes provided via this flag take priority over the index specified by
+    /// `--default-index` (which defaults to PyPI). When multiple `--index` flags are
+    /// provided, earlier values take priority.
+    #[arg(long, env = "UV_INDEX", value_delimiter = ' ', value_parser = parse_index_source, help_heading = "Index options")]
+    pub index: Option<Vec<Maybe<IndexSource>>>,
 
-    /// Extra URLs of package indexes to use, in addition to `--index-url`.
+    /// The URL of the default package index (by default: <https://pypi.org/simple>).
     ///
     /// Accepts either a repository compliant with PEP 503 (the simple repository API), or a local
     /// directory laid out in the same format.
     ///
-    /// All indexes provided via this flag take priority over the index specified by
-    /// `--index-url` (which defaults to PyPI). When multiple `--extra-index-url` flags are
-    /// provided, earlier values take priority.
-    #[arg(long, env = "UV_INDEX", value_delimiter = ' ', value_parser = parse_index_source, help_heading = "Index options")]
-    pub index: Option<Vec<Maybe<IndexSource>>>,
+    /// The index given by this flag is given lower priority than all other indexes specified via
+    /// the `--index` flag.
+    #[arg(long, env = "UV_DEFAULT_INDEX", value_parser = parse_default_index_source, help_heading = "Index options")]
+    pub default_index: Option<Maybe<IndexSource>>,
 
     /// The URL of the Python package index (by default: <https://pypi.org/simple>).
     ///
@@ -3730,6 +3730,8 @@ pub struct IndexArgs {
     ///
     /// The index given by this flag is given lower priority than all other
     /// indexes specified via the `--extra-index-url` flag.
+    ///
+    /// (Deprecated: use `--default-index` instead.)
     #[arg(long, short, env = "UV_INDEX_URL", value_parser = parse_index_url, help_heading = "Index options")]
     pub index_url: Option<Maybe<IndexUrl>>,
 
@@ -3741,6 +3743,8 @@ pub struct IndexArgs {
     /// All indexes provided via this flag take priority over the index specified by
     /// `--index-url` (which defaults to PyPI). When multiple `--extra-index-url` flags are
     /// provided, earlier values take priority.
+    ///
+    /// (Deprecated: use `--index` instead.)
     #[arg(long, env = "UV_EXTRA_INDEX_URL", value_delimiter = ' ', value_parser = parse_index_url, help_heading = "Index options")]
     pub extra_index_url: Option<Vec<Maybe<IndexUrl>>>,
 

crates/uv-settings/src/settings.rs

@@ -296,15 +296,13 @@ pub struct ResolverOptions {
 #[serde(rename_all = "kebab-case")]
 #[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
 pub struct ResolverInstallerOptions {
-    /// The indexes to use when resolving dependencies.
+    /// The package indexes to use when resolving dependencies.
     ///
     /// Accepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/)
     /// (the simple repository API), or a local directory laid out in the same format.
     ///
     /// Indexes are considered in the order in which they're defined, such that the first-defined
-    /// index has the highest priority. Further, the indexes provided by this setting are given
-    /// higher priority than any indexes specified via [`index_url`](#index-url) or
-    /// [`extra_index_url`](#extra-index-url).
+    /// index has the highest priority.
     ///
     /// If an index is marked as `explicit = true`, it will be used exclusively for those
     /// dependencies that select it explicitly via `[tool.uv.sources]`, as in:
@@ -319,9 +317,9 @@ pub struct ResolverInstallerOptions {
     /// torch = { index = "pytorch" }
     /// ```
     ///
-    /// If an index is marked as `default = true`, it will be moved to the front of the list of
-    /// the list of indexes, such that it is given the highest priority when resolving packages.
-    /// Additionally, marking an index as default will disable the PyPI default index.
+    /// Marking an index as `default = true` will disable the PyPI default index and move the
+    /// index to the end of the prioritized list, such that it is used when a package is not found
+    /// on any other index.
     #[option(
         default = "\"[]\"",
         value_type = "dict",
@@ -338,7 +336,9 @@ pub struct ResolverInstallerOptions {
     /// (the simple repository API), or a local directory laid out in the same format.
     ///
     /// The index provided by this setting is given lower priority than any indexes specified via
-    /// [`extra_index_url`](#extra-index-url).
+    /// [`extra_index_url`](#extra-index-url) or [`index`](#index).
+    ///
+    /// (Deprecated: use `index` instead.)
     #[option(
         default = "\"https://pypi.org/simple\"",
         value_type = "str",
@@ -353,10 +353,13 @@ pub struct ResolverInstallerOptions {
     /// (the simple repository API), or a local directory laid out in the same format.
     ///
     /// All indexes provided via this flag take priority over the index specified by
-    /// [`index_url`](#index-url). When multiple indexes are provided, earlier values take priority.
+    /// [`index_url`](#index-url) or [`index`](#index) with `default = true`. When multiple indexes
+    /// are provided, earlier values take priority.
     ///
     /// To control uv's resolution strategy when multiple indexes are present, see
     /// [`index_strategy`](#index-strategy).
+    ///
+    /// (Deprecated: use `index` instead.)
     #[option(
         default = "[]",
         value_type = "list[str]",