Invalid annotation keyword format detected RB-ST1023
Style
Minor
5 months ago
—
3 years old
Annotation keywords like
Note should be all upper case, followed by a colon, and a space, then a note describing the problem.277 end
278
279 def utf8_friendly_extractor(text, options = {})
280 # Note: I couldn't obtain list_slug with @user/list-name format281 # for mention so this requires additional check
282 special = Extractor.extract_urls_with_indices(text, options)
283 standard = Extractor.extract_entities_with_indices(text, options)
Description
The annotation keyword is followed by a colon and a space, then a note describing the problem.
Supported keywords are TODO, FIXME, OPTIMIZE, HACK and REVIEW.
Bad practice
def bar
# FIXME This has crashed occasionally since v3.2.1.
baz(:quux)
end
Recommended
def bar
# FIXME: This has crashed occasionally since v3.2.1.
baz(:quux)
end