Skip to content

Update data guideline: Parameters and parameter object features #29856

Description

@Elchi3

This data guideline needs to be updated: https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines/README.md#parameters-and-parameter-object-features

See the discussion in #29739 (comment) as well as #29451 which used a nested structure.

In today's BCD call, we agreed that nesting structures are better.

  • Better validation/linting is in place if features are properly nested.
  • MDN rendering for deeply nested features is AFAIK not a problem anymore.

So the guidelines should reflect that and present how to nest parameters keys correctly. It will probably look like this:

  • someMethod
    • options_parameter
      • propA
      • propB
      • propC_options_parameter (we don't need the longer names)

We should be using names from the specification (there are different names for the object parameters like "option", "init", "configuration")

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions