mdn / mdn/browser-compat-data

Survey existing data conventions for method parameters, especially parameter objects

Open
#29,572 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
JSON
Stars
5.8k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
186

Description

We should survey the way we actually record parameter object data and establish a guideline.

Background

We have a guideline for creating subfeatures for methods' parameters and parameters that are objects. In some cases we follow this guideline (flattening parameter objects), but in many other cases we do not.

Task

Read the existing guideline. Go through the api tree, looking for parameter entries (typically, keys with _parameter in the key name). For each one, record whether the parameter is a dictionary or not, and what, if any, subfeatures or sibling features are associated with that parameter. When that's done, summarize the results: identify the naming and structuring schemes that exist and which ones are most commonly used.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/data-guidelines, especially the parameters-and-parameter-object-features section, then search the api tree for keys containing _parameter. Record whether each parameter is a dictionary and its subfeatures or sibling features. Summarize the naming and structure patterns found, noting which are most common; completion is the survey and guideline-oriented summary.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
data, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.