Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misleading comment #70

Closed
maeb opened this issue Dec 5, 2023 · 1 comment
Closed

Misleading comment #70

maeb opened this issue Dec 5, 2023 · 1 comment
Labels
documentation New or enhanced documentation

Comments

@maeb
Copy link
Member

maeb commented Dec 5, 2023

The following comment:

// WarcRecord will always be nil if error is returned.

seems to be inaccurate because
wf.currentRecord, recordOffset, validation, err = wf.warcReader.Unmarshal(wf.bufferedReader)

leads to

gowarc/unmarshaler.go

Lines 196 to 202 in 614c93d

err = record.parseBlock(bufio.NewReader(content), validation)
if err != nil {
return record, offset, validation, err
}
err = record.ValidateDigest(validation)
return record, offset, validation, err

which returns a warcRecord which is not nil on error.

johnerikhalse added a commit that referenced this issue Dec 8, 2023
@johnerikhalse johnerikhalse added the documentation New or enhanced documentation label Dec 8, 2023
@johnerikhalse
Copy link
Contributor

This will be fixed in PR #69

johnerikhalse added a commit that referenced this issue Dec 11, 2023
* Bump versions of Github workflow actions

* Improved a lot of documentation

* Moved README.md to docs directory and updated package documentation. This avoids README showing up in godoc

* Fix for #70 Misleading comment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation New or enhanced documentation
Projects
None yet
Development

No branches or pull requests

2 participants