Skip to content

Commit

Permalink
mhutchie#44 Improved the documentation and descriptions of extension …
Browse files Browse the repository at this point in the history
…settings.
  • Loading branch information
mhutchie committed Apr 1, 2019
1 parent 12832c8 commit 70dae40
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ This extension consumes the following settings:

* `git.path`: Specifies the path of a portable Git installation.

More information on each setting, including detailed descriptions, default values and types is available [here](https://github.com/mhutchie/vscode-git-graph/wiki/Extension-Settings).

## Extension Commands

This extension contributes the following commands:
Expand Down
19 changes: 18 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@
"Date Only",
"Relative"
],
"enumDescriptions": [
"Show the date and time, for example \"19 Mar 2019 21:34\"",
"Show the date only, for example \"19 Mar 2019\"",
"Show relative times, for example \"5 minutes ago\""
],
"default": "Date & Time",
"description": "Specifies the date format to be used in the date column of Git Graph."
},
Expand All @@ -68,6 +73,10 @@
"Author Date",
"Commit Date"
],
"enumDescriptions": [
"Use the author date of a commit",
"Use the committer date of a commit"
],
"default": "Author Date",
"description": "Specifies the date type to be displayed throughout Git Graph."
},
Expand Down Expand Up @@ -100,6 +109,10 @@
"rounded",
"angular"
],
"enumDescriptions": [
"Use smooth curves when transitioning between branches on the graph",
"Use angular lines when transitioning between branches on the graph"
],
"default": "rounded",
"description": "Specifies the style of the graph."
},
Expand All @@ -110,7 +123,7 @@
},
"git-graph.loadMoreCommits": {
"type": "number",
"default": 75,
"default": 100,
"description": "Specifies the number of commits to load when the \"Load More Commits\" button is pressed (only shown when more commits are available)."
},
"git-graph.showCurrentBranchByDefault": {
Expand All @@ -134,6 +147,10 @@
"colour",
"grey"
],
"enumDescriptions": [
"Show a colour icon which suits most Visual Studio Code colour themes",
"Show a grey icon which suits Visual Studio Code colour themes that are predominantly grayscale"
],
"default": "colour",
"description": "Specifies the colour theme of the icon displayed on the Git Graph tab."
}
Expand Down

0 comments on commit 70dae40

Please sign in to comment.