Skip to content

Commit 9dde3fe

Browse files
authored
docs: reorder git examples (#100)
Most to least recent is more conventional.
1 parent 65b3518 commit 9dde3fe

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# `git-draft(1)` [![CI](https://github.com/mtth/git-draft/actions/workflows/ci.yaml/badge.svg)](https://github.com/mtth/git-draft/actions/workflows/ci.yaml) [![codecov](https://codecov.io/gh/mtth/git-draft/graph/badge.svg?token=3OTKAI0FP6)](https://codecov.io/gh/mtth/git-draft) [![Pypi badge](https://badge.fury.io/py/git-draft.svg)](https://pypi.python.org/pypi/git-draft/)
22

33
> [!NOTE]
4-
> WIP: Unstable API.
4+
> WIP: Evolving API.
55
66

77
## Highlights

docs/git-draft.adoc

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ifndef::manversion[:manversion: 0.0.0]
22

33
= git-draft(1)
4-
Matthieu Monsch
4+
Matthieu Monsch <[email protected]>
55
v{manversion}
66
:doctype: manpage
77
:manmanual: GIT-DRAFT
@@ -110,58 +110,58 @@ When the working directory is clean, a single commit is created and set as the d
110110

111111
[source]
112112
----
113-
o <some commit> (main, draft/123)
114113
o draft! prompt: <prompt> (draft/123+, refs/drafts/123/1)
114+
o <some commit> (main, draft/123)
115115
----
116116

117117
If the working directory is dirty, a sync commit is added to identify the LLM-generated changes.
118118

119119
[source]
120120
----
121-
o <some commit> (main, draft/123)
122-
o draft! sync(prompt)
123121
o draft! prompt: <prompt> (draft/123+, refs/drafts/123/1)
122+
o draft! sync(prompt)
123+
o <some commit> (main, draft/123)
124124
----
125125

126126
If merging is enabled, it have both the LLM-generated changes and manual edits as parents.
127127

128128
[source]
129129
----
130-
o <some commit> (main)
130+
o Merge (draft/123, draft/123/+)
131131
|\
132-
| o draft! sync(prompt)
133-
o | draft! sync(merge)
134132
| o draft! prompt: <prompt> (refs/drafts/123/1)
133+
o | draft! sync(merge)
134+
| o draft! sync(prompt)
135135
|/
136-
o Merge (draft/123, draft/123/+)
136+
o <some commit> (main)
137137
----
138138

139139
Otherwise, the user is free to incorporate the changes as needed.
140140
Note that the steps above can be repeated arbitrarily many times within a given draft branch, both with and without automatic merging.
141141

142142
[source]
143143
----
144-
o <some commit> (main)
145-
|\
146-
| o draft! prompt: <prompt1> (refs/drafts/123/1)
147-
o draft! sync(prompt)
148-
o draft! prompt: <prompt2> (refs/drafts/123/2)
149-
o <a manual commit> (draft/123)
150144
o draft! prompt: <prompt3> (draft/123+, refs/drafts/123/3)
145+
o <a manual commit> (draft/123)
146+
o draft! prompt: <prompt2> (refs/drafts/123/2)
147+
o draft! sync(prompt)
148+
| o draft! prompt: <prompt1> (refs/drafts/123/1)
149+
|/
150+
o <some commit> (main)
151151
----
152152

153153
Sync commits will be reused if no new changes were added.
154154
This can be useful when iterating on a prompt, and discarding results from prior iterations.
155155

156156
[source]
157157
----
158-
o <some commit> (main)
159-
o draft! sync(prompt)
160-
|\
161-
| \
162-
|\ o draft! prompt: <prompt1> (refs/drafts/123/1)
163-
| o draft! prompt: <prompt2> (refs/drafts/123/2)
164158
o draft! prompt: <prompt3> (refs/drafts/123/3)
159+
| o draft! prompt: <prompt2> (refs/drafts/123/2)
160+
|/ o draft! prompt: <prompt1> (refs/drafts/123/1)
161+
| /
162+
|/
163+
o draft! sync(prompt)
164+
o <some commit> (main)
165165
----
166166

167167

0 commit comments

Comments
 (0)