Skip to content

Add documentation comments to package tokenizer. #198

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 29, 2019
Merged

Add documentation comments to package tokenizer. #198

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4027b49
Add documentation comments to package tokenizer.
creachadair Jan 29, 2019
dabb415
Apply suggestions from review.
creachadair Jan 29, 2019
5245079
Apply suggestions from review.
creachadair Jan 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions internal/tokenizer/tokenize.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Package tokenizer implements file tokenization used by the enry content
// classifier. This package is an implementation detail of enry and should not
// be imported by other packages.
package tokenizer

import (
Expand All @@ -8,6 +11,9 @@ import (

const byteLimit = 100000

// Tokenize returns language-agnostic lexical tokens from content. The tokens
// returned should match what the Linguist library returns. At most the first
// 100KB of content are tokenized.
func Tokenize(content []byte) []string {
if len(content) > byteLimit {
content = content[:byteLimit]
Expand Down