Skip to content

Commit

Permalink
fix: docs and gitignore.
Browse files Browse the repository at this point in the history
  • Loading branch information
luabagg committed Apr 8, 2023
1 parent b63648b commit e3989bc
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
.vscode
tmp
6 changes: 3 additions & 3 deletions examples_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/luabagg/orcgen"
)

// Example_New gives examples using the New function from orcgen.
// ExampleNew gives examples using the New function from orcgen.
func ExampleNew() {
// starts the connection.
gen := orcgen.New(orcgen.PDF)
Expand Down Expand Up @@ -68,7 +68,7 @@ func ExampleNew() {
// twitter.jpeg generated succesfully
}

// Example_ConvertWebpage gives examples using the ConvertWebpage function from
// ExampleConvertWebpage gives examples using the ConvertWebpage function from
func ExampleConvertWebpage() {
filename := "github.pdf"
err := orcgen.ConvertWebpage(orcgen.PDF, "https://www.github.com", getName(filename))
Expand All @@ -80,7 +80,7 @@ func ExampleConvertWebpage() {
// github.pdf generated succesfully
}

// Example_ConvertHTML gives examples using the ConvertHTML function from
// ExampleConvertHTML gives examples using the ConvertHTML function from
func ExampleConvertHTML() {
filename := "html.pdf"
err := orcgen.ConvertHTML(orcgen.PDF, getHTML(), getName(filename))
Expand Down
2 changes: 1 addition & 1 deletion orcgen.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func ConvertWebpage(ext internal.Ext, url string, output string) error {
return fi.Output(output)
}

// ConvertWebpage converts the informed bytes to the ext format, and saves the file.
// ConvertHTML converts the informed bytes to the ext format, and saves the file.
//
// ext is the extension to be converted to (use the defined constants above).
// html is the html byte array (if it's a filepath, use os.ReadFile(filepath)).
Expand Down

0 comments on commit e3989bc

Please sign in to comment.