Skip to content

Commit

Permalink
Fix incorrect doc comment for NewDocument
Browse files Browse the repository at this point in the history
  • Loading branch information
Katrina Owen committed Aug 20, 2018
1 parent e5a7345 commit 60b6ed7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions workspace/document.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ type Document struct {
RelativePath string
}

// NewDocument creates a document from a relative filepath.
// NewDocument creates a document from the filepath.
// The root is typically the root of the exercise, and
// path is the relative path to the file within the root directory.
// path is the absolute path to the file.
func NewDocument(root, path string) (Document, error) {
path, err := filepath.Rel(root, path)
if err != nil {
Expand Down

0 comments on commit 60b6ed7

Please sign in to comment.