Client API: provide list of deprecated options/properties
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 37k
- Forks
- 3.5k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 22
Description
Expected behavior of the wanted feature
A property which provides a list of deprecated/removed options, similar to property-list, command-list, and options.
Use Case
I have a script which allows people to search for keybinds, commands, options, and properties, and have the results display on the osd. When searching for options and properties the script inevitably ends up accessing information about deprecated/removed options, which causes a huge number of warning/error messages to spam the console. If I had a way to know which options were deprecated before accessing information about them I could skip them in the script. It would also stop deprecated options showing up as seemingly valid entries in the search results.
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 Client API implementations for property-list, command-list, and options first, since the issue proposes a similar property. Determine how deprecated and removed options or properties should be represented and exposed. Done means a client can identify them before querying their information and avoid warning or error spam.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100