Start using option objects rather than positional arguments for methods with lots of parameters
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.4k
- Forks
- 245
- Avg merge
- 5d 2h
- Merged PRs (30d)
- 2
Description
Sigh. I wonder if we should start using option objects rather than positional arguments for methods like this with lots of parameters?
Originally posted by @dpvc in https://github.com/mathjax/MathJax-src/pull/1123#discussion_r1723806700
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the discussion in pull request #1123, which is the only location identified by this issue. Before implementation, establish which methods and parameters are in scope and get agreement on the option-object design; done would require an agreed migration plan and corresponding changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100