Skip to content

Commit

Permalink
docs: improve documentation for private functions
Browse files Browse the repository at this point in the history
  • Loading branch information
Reinaldy Rafli committed Oct 27, 2021
1 parent 096b6b4 commit 0581376
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 153 deletions.
154 changes: 3 additions & 151 deletions .github/codegen.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
*/
const fs = require('fs/promises');

// If you used this codegen, don't forget to reset
// the letters array just to be a single value.
const letters =
[
`
Expand All @@ -11,157 +13,7 @@ const letters =
| (_| |
\\__,_|
`,
` _
| |__
| '_ \\
| |_) |
|_.__/
`,
`
___
/ __|
| (__
\\___|
`,
` _
__| |
/ _ |
| (_| |
\\__,_|
`,
`
___
/ _ \\
| __/
\\___|
`,
` __
/ _|
| |_
| _|
|_|
`,
`
__ _
/ _\` |
| (_| |
\\__, |
|___/ `,
` _
| |__
| '_ \\
| | | |
|_| |_|
`,
` _
(_)
| |
| |
|_|
`,
` _
(_)
| |
| |
_/ |
|__/ `,
` _
| | __
| |/ /
| <
|_|\\_\\
`,
` _
| |
| |
| |
|_|
`,
`
_ __ ___
| '_ \` _ \\
| | | | | |
|_| |_| |_|
`,
`
_ __
| '_ \
| | | |
|_| |_|
`,
`
___
/ _ \
| (_) |
\___/
`,
`
_ __
| '_ \
| |_) |
| .__/
|_| `,
`
__ _
/ _\` |
| (_| |
\\__, |
|_|`,
`
_ __
| '__|
| |
|_|
`,
`
___
/ __|
\\__ \\
|___/
`,
` _
| |_
| __|
| |_
\\__|
`,
`
_ _
| | | |
| |_| |
\\__,_|
`,
`
__ __
\\ \\ / /
\\ V /
\\_/
`,
`
__ __
\\ \\ /\\ / /
\\ V V /
\\_/\\_/
`,
`
__ __
\\ \\/ /
> <
/_/\\_\\
`,
`
_ _
| | | |
| |_| |
\\__, |
|___/ `,
`
____
|_ /
/ /
/___|
`,
]
]

;(async () => {
let output = ''
Expand Down
8 changes: 6 additions & 2 deletions asciitxt.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// ASCIITXT is a simple utility for creating ascii texts.
// ASCIITXT is a simple utility for creating ASCII texts.
// The text that can be created is limited to a certain input as the maintainers
// have to input all the text manually.
package asciitxt

import (
Expand Down Expand Up @@ -61,7 +63,7 @@ func WithConfig(txt string, config Config) string {
return output.String()
}

//
// Get a depth (vertical) length for a certain style.
func getStyleLength(style Style) int {
switch style {
case StyleStandard:
Expand All @@ -71,6 +73,8 @@ func getStyleLength(style Style) int {
}
}

// Get a letter by a certain style.
// It returns a panic if the style input is invalid.
func getStyleLetter(style Style, letter string) []string {
switch style {
case StyleStandard:
Expand Down

0 comments on commit 0581376

Please sign in to comment.