From 087224159e2de46cfba09a6056d4172f36d764a3 Mon Sep 17 00:00:00 2001
From: nils <48135649+Nilstrieb@users.noreply.github.com>
Date: Fri, 14 Oct 2022 17:22:44 +0200
Subject: [PATCH] Update query.md

- queries always need a description
- `QueryDescription` isn't just for descriptions (it's actually not for
  descriptions at all now) and always implemented by the macro
- queries are not grouped into categories
---
 src/query.md | 34 ++++++++--------------------------
 1 file changed, 8 insertions(+), 26 deletions(-)

diff --git a/src/query.md b/src/query.md
index 3d60059b..f7ead413 100644
--- a/src/query.md
+++ b/src/query.md
@@ -180,20 +180,14 @@ the big macro invocation in
 
 ```rust,ignore
 rustc_queries! {
-    Other {
-        /// Records the type of every item.
-        query type_of(key: DefId) -> Ty<'tcx> {
-            cache { key.is_local() }
-        }
+    /// Records the type of every item.
+    query type_of(key: DefId) -> Ty<'tcx> {
+        cache { key.is_local() }
     }
-
     ...
 }
 ```
 
-Queries are grouped into categories (`Other`, `Codegen`, `TypeChecking`, etc.).
-Each group contains one or more queries.
-
 A query definition has the following form:
 
 ```rust,ignore
@@ -260,26 +254,16 @@ impl<'tcx> QueryConfig for type_of<'tcx> {
 }
 ```
 
-There is an additional trait that you may wish to implement called
-[`self::config::QueryDescription`][QueryDescription]. This trait is
-used during cycle errors to give a "human readable" name for the query,
-so that we can summarize what was happening when the cycle occurred.
-Implementing this trait is optional if the query key is `DefId`, but
-if you *don't* implement it, you get a pretty generic error ("processing `foo`...").
-You can put new impls into the `config` module. They look something like this:
+There is an additional trait with more methods called
+[`self::config::QueryDescription`][QueryDescription]. This trait contains a few
+extra methods which are used by the query system.
 
 [QueryConfig]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_query_system/query/config/trait.QueryConfig.html
 [QueryDescription]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_query_system/query/config/trait.QueryDescription.html
 
-```rust,ignore
-impl<'tcx> QueryDescription for queries::type_of<'tcx> {
-    fn describe(tcx: TyCtxt, key: DefId) -> String {
-        format!("computing the type of `{}`", tcx.def_path_str(key))
-    }
-}
-```
 
-Another option is to add `desc` modifier:
+Queries also have a description, which is specified using the `desc` modifier.
+This description is shown to the user when cycle errors happen.
 
 ```rust,ignore
 rustc_queries! {
@@ -292,8 +276,6 @@ rustc_queries! {
 }
 ```
 
-`rustc_queries` macro will generate an appropriate `impl` automatically.
-
 ## External links
 
 Related design ideas, and tracking issues: