Require explicit buy-in to use legacy APIs
- Dominant language
- Python
- Stars
- 497
- Forks
- 77
- Avg merge
- 22h 37m
- Merged PRs (30d)
- 45
Description
Add a `legacy=False` option in `config`. `legacy=True` is required to enable the legacy APIs. These are the APIs listed under Legacy in the API reference. This is the way to start the shift from the current deprecated situation without much friction.
Perhaps the Session hierarchy will include _legacy_ nodes. This means that the main documentation doesn't need to reflect the legacy interfaces at all. Only the Legacy section would mention them.
Contributor guide
Research direction
Start by locating the config definition and reviewing the APIs listed in the API reference's Legacy section. Clarify whether Session hierarchy changes are in scope, then define tests for requiring legacy=True before those APIs can be used and update the legacy documentation accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100