How to deprecate a single parameter
Open
Nobody has claimed this yet.
general discussion
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
https://github.com/palantir/tslint/issues/4281 is an example of a scenario where a single parameter is deprecated: moving from multiple standalone arguments to a single arguments object, while maintaining backwards compatibility.
Can we mark just that parameter as deprecated? Something like:
export interface IFormatter {
/**
* Formats linter results
* @param failures - Linter failures that were not fixed
* @param @deprecated fixes - Fixed linter failures. Available when the `--fix` argument is used on the command line.
*/
format(failures: RuleFailure[], fixes?: RuleFailure[]): string;
}
Contributor guide
No contributing guide indexed for this repository
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
Review the linked TSLint issue and the IFormatter example to understand the single-parameter deprecation scenario. Determine the TSDoc syntax and expected behavior for deprecating only fixes, then document the accepted form and validate it against the relevant specification or parser behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100