Skip to content

Commit 5908922

Browse files
authored
fix: rendering of MIRROR_FUNCS.md on GitHub (#77)
1 parent e246788 commit 5908922

File tree

2 files changed

+59
-202
lines changed

2 files changed

+59
-202
lines changed

MIRROR_FUNCS.md

Lines changed: 53 additions & 200 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,54 @@
1-
<tr>
2-
<td><code>func (*bufio.Writer) Write([]byte) (int, error)</code></td>
3-
<td><code>func (*bufio.Writer) WriteString(string) (int, error)</code></td>
4-
</tr>
5-
<tr>
6-
<td><code>func (*bufio.Writer) WriteRune(rune) (int, error)</code></td>
7-
<td><code>func (*bufio.Writer) WriteString(string) (int, error)</code></td>
8-
</tr>
9-
<tr>
10-
<td><code>func (*bytes.Buffer) Write([]byte) (int, error)</code></td>
11-
<td><code>func (*bytes.Buffer) WriteString(string) (int, error)</code></td>
12-
</tr>
13-
<tr>
14-
<td><code>func (*bytes.Buffer) WriteRune(rune) (int, error)</code></td>
15-
<td><code>func (*bytes.Buffer) WriteString(string) (int, error)</code></td>
16-
</tr>
17-
<tr>
18-
<td><code>func bytes.Compare([]byte, []byte) int</code></td>
19-
<td><code>func strings.Compare(string, string) int</code></td>
20-
</tr>
21-
<tr>
22-
<td><code>func bytes.Contains([]byte, []byte) bool</code></td>
23-
<td><code>func strings.Contains(string, string) bool</code></td>
24-
</tr>
25-
<tr>
26-
<td><code>func bytes.ContainsAny([]byte, string) bool</code></td>
27-
<td><code>func strings.ContainsAny(string, string) bool</code></td>
28-
</tr>
29-
<tr>
30-
<td><code>func bytes.ContainsRune([]byte, byte) bool</code></td>
31-
<td><code>func strings.ContainsRune(string, byte) bool</code></td>
32-
</tr>
33-
<tr>
34-
<td><code>func bytes.Count([]byte, []byte) int</code></td>
35-
<td><code>func strings.Count(string, string) int</code></td>
36-
</tr>
37-
<tr>
38-
<td><code>func bytes.EqualFold([]byte, []byte) bool</code></td>
39-
<td><code>func strings.EqualFold(string, string) bool</code></td>
40-
</tr>
41-
<tr>
42-
<td><code>func bytes.HasPrefix([]byte, []byte) bool</code></td>
43-
<td><code>func strings.HasPrefix(string, string) bool</code></td>
44-
</tr>
45-
<tr>
46-
<td><code>func bytes.HasSuffix([]byte, []byte) bool</code></td>
47-
<td><code>func strings.HasSuffix(string, string) bool</code></td>
48-
</tr>
49-
<tr>
50-
<td><code>func bytes.Index([]byte, []byte) int</code></td>
51-
<td><code>func strings.Index(string, string) int</code></td>
52-
</tr>
53-
<tr>
54-
<td><code>func bytes.IndexAny([]byte, string) int</code></td>
55-
<td><code>func strings.IndexAny(string, string) int</code></td>
56-
</tr>
57-
<tr>
58-
<td><code>func bytes.IndexByte([]byte, byte) int</code></td>
59-
<td><code>func strings.IndexByte(string, byte) int</code></td>
60-
</tr>
61-
<tr>
62-
<td><code>func bytes.IndexFunc([]byte, func(rune) bool) int</code></td>
63-
<td><code>func strings.IndexFunc(string, func(rune) bool) int</code></td>
64-
</tr>
65-
<tr>
66-
<td><code>func bytes.IndexRune([]byte, rune) int</code></td>
67-
<td><code>func strings.IndexRune(string, rune) int</code></td>
68-
</tr>
69-
<tr>
70-
<td><code>func bytes.LastIndex([]byte, []byte) int</code></td>
71-
<td><code>func strings.LastIndex(string, string) int</code></td>
72-
</tr>
73-
<tr>
74-
<td><code>func bytes.LastIndexAny([]byte, string) int</code></td>
75-
<td><code>func strings.LastIndexAny(string, string) int</code></td>
76-
</tr>
77-
<tr>
78-
<td><code>func bytes.LastIndexByte([]byte, byte) int</code></td>
79-
<td><code>func strings.LastIndexByte(string, byte) int</code></td>
80-
</tr>
81-
<tr>
82-
<td><code>func bytes.LastIndexFunc([]byte, func(rune) bool) int</code></td>
83-
<td><code>func strings.LastIndexFunc(string, func(rune) bool) int</code></td>
84-
</tr>
85-
<tr>
86-
<td><code>func bytes.NewBuffer([]byte) *bytes.Buffer</code></td>
87-
<td><code>func bytes.NewBufferString(string) *bytes.Buffer</code></td>
88-
</tr>
89-
<tr>
90-
<td><code>func (*httptest.ResponseRecorder) Write([]byte) (int, error)</code></td>
91-
<td><code>func (*httptest.ResponseRecorder) WriteString(string) (int, error)</code></td>
92-
</tr>
93-
<tr>
94-
<td><code>func (*maphash.Hash) Write([]byte) (int, error)</code></td>
95-
<td><code>func (*maphash.Hash) WriteString(string) (int, error)</code></td>
96-
</tr>
97-
<tr>
98-
<td><code>func (*os.File) Write([]byte) (int, error)</code></td>
99-
<td><code>func (*os.File) WriteString(string) (int, error)</code></td>
100-
</tr>
101-
<tr>
102-
<td><code>func regexp.Match(string, []byte) (bool, error)</code></td>
103-
<td><code>func regexp.MatchString(string, string) (bool, error)</code></td>
104-
</tr>
105-
<tr>
106-
<td><code>func (*regexp.Regexp) FindAllIndex([]byte, int) [][]int</code></td>
107-
<td><code>func (*regexp.Regexp) FindAllStringIndex(string, int) [][]int</code></td>
108-
</tr>
109-
<tr>
110-
<td><code>func (*regexp.Regexp) FindAllSubmatchIndex([]byte, int) [][]int</code></td>
111-
<td><code>func (*regexp.Regexp) FindAllStringSubmatchIndex(string, int) [][]int</code></td>
112-
</tr>
113-
<tr>
114-
<td><code>func (*regexp.Regexp) FindIndex([]byte) []int</code></td>
115-
<td><code>func (*regexp.Regexp) FindStringIndex(string) []int</code></td>
116-
</tr>
117-
<tr>
118-
<td><code>func (*regexp.Regexp) FindSubmatchIndex([]byte) []int</code></td>
119-
<td><code>func (*regexp.Regexp) FindStringSubmatchIndex(string) []int</code></td>
120-
</tr>
121-
<tr>
122-
<td><code>func (*regexp.Regexp) Match([]byte) bool</code></td>
123-
<td><code>func (*regexp.Regexp) MatchString(string) bool</code></td>
124-
</tr>
125-
<tr>
126-
<td><code>func (*strings.Builder) Write([]byte) (int, error)</code></td>
127-
<td><code>func (*strings.Builder) WriteString(string) (int, error)</code></td>
128-
</tr>
129-
<tr>
130-
<td><code>func (*strings.Builder) WriteRune(rune) (int, error)</code></td>
131-
<td><code>func (*strings.Builder) WriteString(string) (int, error)</code></td>
132-
</tr>
133-
<tr>
134-
<td><code>func strings.Compare(string) int</code></td>
135-
<td><code>func bytes.Compare([]byte) int</code></td>
136-
</tr>
137-
<tr>
138-
<td><code>func strings.Contains(string) bool</code></td>
139-
<td><code>func bytes.Contains([]byte) bool</code></td>
140-
</tr>
141-
<tr>
142-
<td><code>func strings.ContainsAny(string) bool</code></td>
143-
<td><code>func bytes.ContainsAny([]byte) bool</code></td>
144-
</tr>
145-
<tr>
146-
<td><code>func strings.ContainsRune(string) bool</code></td>
147-
<td><code>func bytes.ContainsRune([]byte) bool</code></td>
148-
</tr>
149-
<tr>
150-
<td><code>func strings.EqualFold(string) bool</code></td>
151-
<td><code>func bytes.EqualFold([]byte) bool</code></td>
152-
</tr>
153-
<tr>
154-
<td><code>func strings.HasPrefix(string) bool</code></td>
155-
<td><code>func bytes.HasPrefix([]byte) bool</code></td>
156-
</tr>
157-
<tr>
158-
<td><code>func strings.HasSuffix(string) bool</code></td>
159-
<td><code>func bytes.HasSuffix([]byte) bool</code></td>
160-
</tr>
161-
<tr>
162-
<td><code>func strings.Index(string) int</code></td>
163-
<td><code>func bytes.Index([]byte) int</code></td>
164-
</tr>
165-
<tr>
166-
<td><code>func strings.IndexFunc(string, func(r rune) bool) int</code></td>
167-
<td><code>func bytes.IndexFunc([]byte, func(r rune) bool) int</code></td>
168-
</tr>
169-
<tr>
170-
<td><code>func strings.LastIndex(string) int</code></td>
171-
<td><code>func bytes.LastIndex([]byte) int</code></td>
172-
</tr>
173-
<tr>
174-
<td><code>func strings.LastIndexAny(string) int</code></td>
175-
<td><code>func bytes.LastIndexAny([]byte) int</code></td>
176-
</tr>
177-
<tr>
178-
<td><code>func strings.LastIndexFunc(string, func(r rune) bool) int</code></td>
179-
<td><code>func bytes.LastIndexFunc([]byte, func(r rune) bool) int</code></td>
180-
</tr>
181-
<tr>
182-
<td><code>func utf8.DecodeLastRune([]byte) (rune, int)</code></td>
183-
<td><code>func utf8.DecodeLastRuneInString(string) (rune, int)</code></td>
184-
</tr>
185-
<tr>
186-
<td><code>func utf8.DecodeRune([]byte) (rune, int)</code></td>
187-
<td><code>func utf8.DecodeRuneInString(string) (rune, int)</code></td>
188-
</tr>
189-
<tr>
190-
<td><code>func utf8.FullRune([]byte) bool</code></td>
191-
<td><code>func utf8.FullRuneInString(string) bool</code></td>
192-
</tr>
193-
<tr>
194-
<td><code>func utf8.RuneCount([]byte) int</code></td>
195-
<td><code>func utf8.RuneCountInString(string) int</code></td>
196-
</tr>
197-
<tr>
198-
<td><code>func utf8.Valid([]byte) bool</code></td>
199-
<td><code>func utf8.ValidString(string) bool</code></td>
200-
</tr>
1+
<!-- This file is @generated by mirror-table, do not edit it manually -->
2012

3+
| Function | Mirror |
4+
|----------|--------|
5+
| `func (*bufio.Writer) Write([]byte) (int, error)` | `func (*bufio.Writer) WriteString(string) (int, error)` |
6+
| `func (*bufio.Writer) WriteRune(rune) (int, error)` | `func (*bufio.Writer) WriteString(string) (int, error)` |
7+
| `func (*bytes.Buffer) Write([]byte) (int, error)` | `func (*bytes.Buffer) WriteString(string) (int, error)` |
8+
| `func (*bytes.Buffer) WriteRune(rune) (int, error)` | `func (*bytes.Buffer) WriteString(string) (int, error)` |
9+
| `func bytes.Compare([]byte, []byte) int` | `func strings.Compare(string, string) int` |
10+
| `func bytes.Contains([]byte, []byte) bool` | `func strings.Contains(string, string) bool` |
11+
| `func bytes.ContainsAny([]byte, string) bool` | `func strings.ContainsAny(string, string) bool` |
12+
| `func bytes.ContainsRune([]byte, byte) bool` | `func strings.ContainsRune(string, byte) bool` |
13+
| `func bytes.Count([]byte, []byte) int` | `func strings.Count(string, string) int` |
14+
| `func bytes.EqualFold([]byte, []byte) bool` | `func strings.EqualFold(string, string) bool` |
15+
| `func bytes.HasPrefix([]byte, []byte) bool` | `func strings.HasPrefix(string, string) bool` |
16+
| `func bytes.HasSuffix([]byte, []byte) bool` | `func strings.HasSuffix(string, string) bool` |
17+
| `func bytes.Index([]byte, []byte) int` | `func strings.Index(string, string) int` |
18+
| `func bytes.IndexAny([]byte, string) int` | `func strings.IndexAny(string, string) int` |
19+
| `func bytes.IndexByte([]byte, byte) int` | `func strings.IndexByte(string, byte) int` |
20+
| `func bytes.IndexFunc([]byte, func(rune) bool) int` | `func strings.IndexFunc(string, func(rune) bool) int` |
21+
| `func bytes.IndexRune([]byte, rune) int` | `func strings.IndexRune(string, rune) int` |
22+
| `func bytes.LastIndex([]byte, []byte) int` | `func strings.LastIndex(string, string) int` |
23+
| `func bytes.LastIndexAny([]byte, string) int` | `func strings.LastIndexAny(string, string) int` |
24+
| `func bytes.LastIndexByte([]byte, byte) int` | `func strings.LastIndexByte(string, byte) int` |
25+
| `func bytes.LastIndexFunc([]byte, func(rune) bool) int` | `func strings.LastIndexFunc(string, func(rune) bool) int` |
26+
| `func bytes.NewBuffer([]byte) *bytes.Buffer` | `func bytes.NewBufferString(string) *bytes.Buffer` |
27+
| `func (*httptest.ResponseRecorder) Write([]byte) (int, error)` | `func (*httptest.ResponseRecorder) WriteString(string) (int, error)` |
28+
| `func (*maphash.Hash) Write([]byte) (int, error)` | `func (*maphash.Hash) WriteString(string) (int, error)` |
29+
| `func (*os.File) Write([]byte) (int, error)` | `func (*os.File) WriteString(string) (int, error)` |
30+
| `func regexp.Match(string, []byte) (bool, error)` | `func regexp.MatchString(string, string) (bool, error)` |
31+
| `func (*regexp.Regexp) FindAllIndex([]byte, int) [][]int` | `func (*regexp.Regexp) FindAllStringIndex(string, int) [][]int` |
32+
| `func (*regexp.Regexp) FindAllSubmatchIndex([]byte, int) [][]int` | `func (*regexp.Regexp) FindAllStringSubmatchIndex(string, int) [][]int` |
33+
| `func (*regexp.Regexp) FindIndex([]byte) []int` | `func (*regexp.Regexp) FindStringIndex(string) []int` |
34+
| `func (*regexp.Regexp) FindSubmatchIndex([]byte) []int` | `func (*regexp.Regexp) FindStringSubmatchIndex(string) []int` |
35+
| `func (*regexp.Regexp) Match([]byte) bool` | `func (*regexp.Regexp) MatchString(string) bool` |
36+
| `func (*strings.Builder) Write([]byte) (int, error)` | `func (*strings.Builder) WriteString(string) (int, error)` |
37+
| `func (*strings.Builder) WriteRune(rune) (int, error)` | `func (*strings.Builder) WriteString(string) (int, error)` |
38+
| `func strings.Compare(string) int` | `func bytes.Compare([]byte) int` |
39+
| `func strings.Contains(string) bool` | `func bytes.Contains([]byte) bool` |
40+
| `func strings.ContainsAny(string) bool` | `func bytes.ContainsAny([]byte) bool` |
41+
| `func strings.ContainsRune(string) bool` | `func bytes.ContainsRune([]byte) bool` |
42+
| `func strings.EqualFold(string) bool` | `func bytes.EqualFold([]byte) bool` |
43+
| `func strings.HasPrefix(string) bool` | `func bytes.HasPrefix([]byte) bool` |
44+
| `func strings.HasSuffix(string) bool` | `func bytes.HasSuffix([]byte) bool` |
45+
| `func strings.Index(string) int` | `func bytes.Index([]byte) int` |
46+
| `func strings.IndexFunc(string, func(r rune) bool) int` | `func bytes.IndexFunc([]byte, func(r rune) bool) int` |
47+
| `func strings.LastIndex(string) int` | `func bytes.LastIndex([]byte) int` |
48+
| `func strings.LastIndexAny(string) int` | `func bytes.LastIndexAny([]byte) int` |
49+
| `func strings.LastIndexFunc(string, func(r rune) bool) int` | `func bytes.LastIndexFunc([]byte, func(r rune) bool) int` |
50+
| `func utf8.DecodeLastRune([]byte) (rune, int)` | `func utf8.DecodeLastRuneInString(string) (rune, int)` |
51+
| `func utf8.DecodeRune([]byte) (rune, int)` | `func utf8.DecodeRuneInString(string) (rune, int)` |
52+
| `func utf8.FullRune([]byte) bool` | `func utf8.FullRuneInString(string) bool` |
53+
| `func utf8.RuneCount([]byte) int` | `func utf8.RuneCountInString(string) int` |
54+
| `func utf8.Valid([]byte) bool` | `func utf8.ValidString(string) bool` |

cmd/internal/mirror-table/main.go

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,13 @@ func main() {
5454

5555
var bb bytes.Buffer
5656

57+
fmt.Fprintf(&bb, "<!-- This file is @generated by mirror-table, do not edit it manually -->\n\n")
58+
fmt.Fprint(&bb, `| Function | Mirror |
59+
|----------|--------|
60+
`)
5761
for _, k := range sortKeys {
58-
fmt.Fprintf(&bb, "<tr>\n<td><code>%s</code></td>\n<td><code>%s</code></td>\n</tr>\n", k, keys[k])
62+
fmt.Fprintf(&bb, "| `%s` | `%s` |\n", k, keys[k])
5963
}
6064

61-
fmt.Println(bb.String())
65+
fmt.Print(bb.String())
6266
}

0 commit comments

Comments
 (0)