From 10226a39927c898d2065f7390752b7b711728a06 Mon Sep 17 00:00:00 2001 From: Thorsten Ball Date: Thu, 31 Oct 2024 09:36:05 +0100 Subject: [PATCH] docs: Document inline blame options (#20006) Release Notes: - N/A --- assets/settings/default.json | 6 ++++++ docs/src/configuring-zed.md | 26 ++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/assets/settings/default.json b/assets/settings/default.json index 52950522154e5d72c03860ee5f38b0d1a0fdb63a..c2f0275744559c57c44a137905362f72a6f044c2 100644 --- a/assets/settings/default.json +++ b/assets/settings/default.json @@ -652,6 +652,12 @@ // Sets a delay after which the inline blame information is shown. // Delay is restarted with every cursor movement. // "delay_ms": 600 + // + // Whether or not do display the git commit summary on the same line. + // "show_commit_summary": false + // + // The minimum column number to show the inline blame information at + // "min_column": 0 } }, // Configuration for how direnv configuration should be loaded. May take 2 values: diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md index d8105b4537b6846cf34fdc9f53cc5d70ebe82a26..11c6fdc09d9faa6452c468c9080778286159ddc2 100644 --- a/docs/src/configuring-zed.md +++ b/docs/src/configuring-zed.md @@ -1043,6 +1043,32 @@ To interpret all `.c` files as C++, files called `MyLockFile` as TOML and files } ``` +3. Show a commit summary next to the commit date and author: + +```json +{ + "git": { + "inline_blame": { + "enabled": true, + "show_commit_summary": true + } + } +} +``` + +4. Use this as the minimum column at which to display inline blame information: + +```json +{ + "git": { + "inline_blame": { + "enabled": true, + "min_column": 80 + } + } +} +``` + ## Indent Guides - Description: Configuration related to indent guides. Indent guides can be configured separately for each language.