# Inch CI

Mustermann::StringScanner#scan

Parsed documentation:

Checks if the given pattern matches any substring starting at the current position.

If it does, it will advance the current {#position} to the end of the substring and merges any params parsed
from the substring into {#params}.

@param (see Mustermann.new)
@return [Mustermann::StringScanner::ScanResult, nil] the matched substring, nil if it didn't match

Suggestions:

Add a code example (optional).
Describe the parameter "pattern".

Please help! Open an issue on GitHub if this assessment is incorrect.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.