Replace "TBD" with more helpful desciptions in published crates' [package.description] fields

regexident · regexident · commit 88ea306270e6 · 2024-08-06T00:25:02.000+02:00
diff --git a/src/tools/rust-analyzer/crates/base-db/Cargo.toml b/src/tools/rust-analyzer/crates/base-db/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "base-db"
 version = "0.0.0"
-description = "TBD"
+description = "Basic database traits. The concrete DB is defined by `ra_ap_ide`."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/cfg/Cargo.toml b/src/tools/rust-analyzer/crates/cfg/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "cfg"
 version = "0.0.0"
-description = "TBD"
+description = "Conditional compiling options, `cfg` attribute parser and evaluator."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/flycheck/Cargo.toml b/src/tools/rust-analyzer/crates/flycheck/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "flycheck"
 version = "0.0.0"
-description = "TBD"
+description = "Functionality needed to run `cargo` commands in a background thread."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/hir-def/Cargo.toml b/src/tools/rust-analyzer/crates/hir-def/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "hir-def"
 version = "0.0.0"
-description = "TBD"
+description = "Everything between macro expansion and type inference for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/hir-expand/Cargo.toml b/src/tools/rust-analyzer/crates/hir-expand/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "hir-expand"
 version = "0.0.0"
-description = "TBD"
+description = "Macro expansion for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/hir-ty/Cargo.toml b/src/tools/rust-analyzer/crates/hir-ty/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "hir-ty"
 version = "0.0.0"
-description = "TBD"
+description = "The type system for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/hir/Cargo.toml b/src/tools/rust-analyzer/crates/hir/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "hir"
 version = "0.0.0"
-description = "TBD"
+description = "A high-level object oriented access to Rust code."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide-assists/Cargo.toml b/src/tools/rust-analyzer/crates/ide-assists/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "ide-assists"
 version = "0.0.0"
-description = "TBD"
+description = "Code assists for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide-completion/Cargo.toml b/src/tools/rust-analyzer/crates/ide-completion/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "ide-completion"
 version = "0.0.0"
-description = "TBD"
+description = "Utilities for generating completions of user input."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide-db/Cargo.toml b/src/tools/rust-analyzer/crates/ide-db/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "ide-db"
 version = "0.0.0"
-description = "TBD"
+description = "Core data-structure representing IDE state."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide-diagnostics/Cargo.toml b/src/tools/rust-analyzer/crates/ide-diagnostics/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "ide-diagnostics"
 version = "0.0.0"
-description = "TBD"
+description = "Diagnostics rendering and fixits."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide-ssr/Cargo.toml b/src/tools/rust-analyzer/crates/ide-ssr/Cargo.toml
@@ -1,8 +1,8 @@
 [package]
 name = "ide-ssr"
 version = "0.0.0"
-description = "Structural search and replace of Rust code"
 repository = "https://github.com/rust-lang/rust-analyzer"
+description = "Structural search and replace of Rust code."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/ide/Cargo.toml b/src/tools/rust-analyzer/crates/ide/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "ide"
 version = "0.0.0"
-description = "TBD"
+description = "IDE-centric APIs for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/intern/Cargo.toml b/src/tools/rust-analyzer/crates/intern/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "intern"
 version = "0.0.0"
-description = "TBD"
+description = "Global `Arc`-based object interning infrastructure."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/limit/Cargo.toml b/src/tools/rust-analyzer/crates/limit/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "limit"
 version = "0.0.0"
-description = "TBD"
+description = "A struct to enforce limits."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/load-cargo/Cargo.toml b/src/tools/rust-analyzer/crates/load-cargo/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "load-cargo"
 version = "0.0.0"
-description = "TBD"
+description = "Loads a Cargo project into a static instance of analysis."
 
 rust-version.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/mbe/Cargo.toml b/src/tools/rust-analyzer/crates/mbe/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "mbe"
 version = "0.0.0"
-description = "TBD"
+description = "Handling of `macro_rules` macros for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/parser/Cargo.toml b/src/tools/rust-analyzer/crates/parser/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "parser"
 version = "0.0.0"
-description = "TBD"
+description = "The Rust parser for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/paths/Cargo.toml b/src/tools/rust-analyzer/crates/paths/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "paths"
 version = "0.0.0"
-description = "TBD"
+description = "Path wrappers for absolute and relative paths."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/proc-macro-api/Cargo.toml b/src/tools/rust-analyzer/crates/proc-macro-api/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "proc-macro-api"
 version = "0.0.0"
-description = "TBD"
+description = "Client-side proc-macros for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/proc-macro-srv-cli/Cargo.toml b/src/tools/rust-analyzer/crates/proc-macro-srv-cli/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "proc-macro-srv-cli"
 version = "0.0.0"
-description = "TBD"
+description = "A standalone binary for `proc-macro-srv`."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/proc-macro-srv/Cargo.toml b/src/tools/rust-analyzer/crates/proc-macro-srv/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "proc-macro-srv"
 version = "0.0.0"
-description = "TBD"
+description = "Proc-macro server for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/profile/Cargo.toml b/src/tools/rust-analyzer/crates/profile/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "profile"
 version = "0.0.0"
-description = "TBD"
+description = "A collection of tools for profiling rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/project-model/Cargo.toml b/src/tools/rust-analyzer/crates/project-model/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "project-model"
 version = "0.0.0"
-description = "TBD"
+description = "A representation for a Cargo project for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/span/Cargo.toml b/src/tools/rust-analyzer/crates/span/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "span"
 version = "0.0.0"
-description = "TBD"
+description = "File and span related types for rust-analyzer."
 
 rust-version.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/stdx/Cargo.toml b/src/tools/rust-analyzer/crates/stdx/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "stdx"
 version = "0.0.0"
-description = "TBD"
+description = "Missing batteries for standard libraries for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/syntax/Cargo.toml b/src/tools/rust-analyzer/crates/syntax/Cargo.toml
@@ -1,8 +1,8 @@
 [package]
 name = "syntax"
 version = "0.0.0"
-description = "Comment and whitespace preserving parser for the Rust language"
 repository = "https://github.com/rust-lang/rust-analyzer"
+description = "Comment and whitespace preserving parser for the Rust language"
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/test-utils/Cargo.toml b/src/tools/rust-analyzer/crates/test-utils/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "test-utils"
 version = "0.0.0"
-description = "TBD"
+description = "Assorted testing utilities for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/text-edit/Cargo.toml b/src/tools/rust-analyzer/crates/text-edit/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "text-edit"
 version = "0.0.0"
-description = "TBD"
+description = "Representation of a `TextEdit` for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/toolchain/Cargo.toml b/src/tools/rust-analyzer/crates/toolchain/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "toolchain"
 version = "0.0.0"
-description = "TBD"
+description = "Discovery of `cargo` & `rustc` executables for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/tt/Cargo.toml b/src/tools/rust-analyzer/crates/tt/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "tt"
 version = "0.0.0"
-description = "TBD"
+description = "A `TokenTree` data structure for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/vfs-notify/Cargo.toml b/src/tools/rust-analyzer/crates/vfs-notify/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "vfs-notify"
 version = "0.0.0"
-description = "TBD"
+description = "Implementation of `loader::Handle` for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
diff --git a/src/tools/rust-analyzer/crates/vfs/Cargo.toml b/src/tools/rust-analyzer/crates/vfs/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "vfs"
 version = "0.0.0"
-description = "TBD"
+description = "A virtual file system for rust-analyzer."
 
 authors.workspace = true
 edition.workspace = true
