This repository has been archived by the owner on Jul 15, 2023. It is now read-only.
function-name rule has mismatches in options schema/meta, readme description, and actually accepted rules #786
Labels
Domain: Documentation
Rules or repository tasks related to how to document code.
Feature request
Is your feature request that we implement a new rule?
No
Is your feature request related to a problem? Please describe.
README description of
function-name
has only description of object with regular expression, but no mention of string flag.function-name
rule meta has only description, schema, and examples of string flags.function-name
rule schema and examples expect string flags right aftertrue
that enables rule, but implementation will parse these flags only as second option.Describe the solution you'd like
Update
README.md
, rules metadata (options description, schema, and examples) to represent both object and string flags.Update rule options parsing so that string flags can be in first position, if configuration object is not provided (when defaults are OK, but need to control over
static private
validation)Describe alternatives you've considered
Update only
README.md
- this will provide info for end user, but will require some effort and may be missed during implementation of Use the same processes to generate documentation as TSLint core #575 or similarRestrict string flags to second position - is doesn't look great set flag as
[true, {}, "validate-private-statics-as-private"]
Additional context
Noticed in scope of #665
The text was updated successfully, but these errors were encountered: