doc: reformat & clarify

This commit is contained in:
Alex Bezzubov 2023-02-16 17:46:23 +01:00
parent 319e630aaf
commit 6d99af7bbc
2 changed files with 11 additions and 9 deletions

View File

@ -124,7 +124,9 @@ func (r always) Match(data []byte) bool {
return true
}
// checks if regular expression syntax isn't accepted by RE2 engine
// Checks if a regex syntax isn't accepted by RE2 engine.
// It's nil by construction from regex.MustCompileRuby but
// is used here as a Matcher interface wich itself is non-nil.
func runOnRE2AndRegexNotAccepted(re Matcher) bool {
v, ok := re.(regex.EnryRegexp)
return ok && v == nil

View File

@ -1,9 +1,9 @@
/*
Package enry implements multiple strategies for programming language identification.
Package enry identifies programming languages.
Identification is made based on file name and file content using a service
of strategies to narrow down possible option.
Each strategy is available as a separate API call, as well as a main enty point
Identification is based on file name and content using a series
of strategies to narrow down possible options.
Each strategy is available as a separate API call, as well as though the main enty point:
GetLanguage(filename string, content []byte) (language string)