Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add deprecation and removal versions to all deprecations across codebase #11020

Open
DitwanP opened this issue Dec 10, 2024 · 2 comments
Open

Add deprecation and removal versions to all deprecations across codebase #11020

DitwanP opened this issue Dec 10, 2024 · 2 comments
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 3 A day or two of work, likely requires updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - medium Issue is non core or affecting less that 60% of people using the library

Comments

@DitwanP
Copy link
Contributor

DitwanP commented Dec 10, 2024 •
edited
Loading

Description

We need to list the version that a deprecation was first deprecated as well as what Calcite version it's slated to be removed.

Which Component

All components

Resources
@DitwanP DitwanP added docs Issues relating to documentation updates only. 0 - new New issues that need assignment. needs triage Planning workflow - pending design/dev review. labels Dec 10, 2024
@DitwanP DitwanP changed the title Add version for removal to all deprecations across codebase. Add deprecation and removal versions to all deprecations across codebase Dec 10, 2024
@benelan
Copy link
Member

benelan commented Dec 10, 2024

We need to make sure the format of the deprecation context is consistent so it can be parsed for the doc site. Maybe something like this:

/**
 * @deprecated since v2.1.3 - removal target v4
 */

@jcfranco
Copy link
Member

@benelan We could look into a custom ESLint rule to help with this.

@driskull driskull added p - medium Issue is non core or affecting less that 60% of people using the library estimate - 3 A day or two of work, likely requires updates to tests. labels Feb 25, 2025
@DitwanP DitwanP added needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. and removed needs triage Planning workflow - pending design/dev review. labels Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0 - new New issues that need assignment. docs Issues relating to documentation updates only. estimate - 3 A day or two of work, likely requires updates to tests. needs milestone Planning workflow - pending milestone assignment, has priority and/or estimate. p - medium Issue is non core or affecting less that 60% of people using the library
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jcfranco @driskull @benelan @DitwanP