Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 32798e2

Browse files
committedMar 15, 2025·
tmp
1 parent 1327b30 commit 32798e2

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed
 

‎docs/src/freckles/cmd/add.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Add
22

3-
This copies a dotfile to the repository and replaces it with a symlink.
3+
Copies a dotfile to the repository and replaces it with a symlink.
44

55
```go
66
{{#include ../../../../cmd/freckles/cmd/add.go:cmd}}
@@ -23,7 +23,6 @@ Completion is provided with [ActionFiles] using a couple of twists.
2323
>
2424
> [Batch] not only enables concurrent invokation of [Actions].
2525
> It also provides a neat way to add them **conditionally**.
26-
>
2726
> See [ActionRefs] for a more sophisticated example.
2827
2928
[Actions]:https://carapace-sh.github.io/carapace/carapace/action.html

‎docs/src/freckles/cmd/edit.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# Edit
22

3+
Opens a dotfile in your editor.
4+
35
```go
46
{{#include ../../../../cmd/freckles/cmd/edit.go:cmd}}
57
```
68

9+
Completion is provided with a [custom action].
10+
711
```go
812
{{#include ../../../../cmd/freckles/cmd/edit.go:positional}}
913
```
@@ -13,5 +17,14 @@
1317
{{#include ../../../../cmd/freckles/cmd/action/freckle.go}}
1418
```
1519

16-
> There are **two major phases** in [Carapace].
20+
> There are **two major phases** in [Carapace]:
21+
> 1. The creation of the command structure and registration of completions.
22+
> 2. The invocation of the [Action] corresponding to current position.
1723
>
24+
> [Custom Actions] should almost always be wrapped in [ActionCallback]
25+
26+
[Action]:https://carapace-sh.github.io/carapace/carapace/action.html
27+
[ActionCallback]:https://carapace-sh.github.io/carapace/carapace/defaultActions/actionCallback.html
28+
[Carapace]:https://carapace.sh
29+
[Custom Actions]:https://carapace-sh.github.io/carapace/carapace/customActions.html
30+
[custom action]:https://carapace-sh.github.io/carapace/carapace/customActions.html

‎docs/src/freckles/cmd/init.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Init
22

3-
[Freckles] is backed by a [Git] repository located at `~/.local/share/freckles`.
4-
5-
With `init` a new one is created.
3+
Creates a new [Git] repository at `~/.local/share/freckles`.
64

75
```go
86
{{#include ../../../../cmd/freckles/cmd/init.go:cmd}}
@@ -56,12 +54,8 @@ Completion is provided by [ActionRepositorySearch].
5654
>
5755
> Note that for performance reasons only the first 100 search results are presented.
5856
> Fast response times are important which limits what can be done in [Carapace].
59-
>
60-
> [Tabdance] will provide a solution for this in the future.
6157
6258
[ActionRepositorySearch]:https://pkg.go.dev/github.com/carapace-sh/carapace-bin/pkg/actions/tools/git#ActionRepositorySearch
6359
[Actions]:https://carapace-sh.github.io/carapace/carapace/action.html
6460
[Carapace]:https://carapace.sh
65-
[Freckles]:https://github.com/rsteube/freckles
6661
[Git]:https://git-scm.com/
67-
[Tabdance]:https://tab.dance

0 commit comments

Comments
 (0)
Please sign in to comment.