Skip to content

[TASK] Deprecate Document::expandShorthands #566

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.

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

Merged

Conversation

ziegenberg
Copy link
Contributor

@ziegenberg ziegenberg commented Jun 18, 2024

The expandShorthands/createShorthands Functions are deprecated and will be removed without substitution in version 10.0. Expanding and creating the shorthand notation is out of the scope of this library. If you want to include this functionality in your project or build it into a separate package, get the code from the v8.5.1 version of this library.

Helps with fixing #512

@ziegenberg ziegenberg changed the title [TASK] Deprecate Document::expandShorthands() [TASK] Deprecate Document::expandShorthands Jun 18, 2024
@ziegenberg ziegenberg force-pushed the deprecate-shorthand-functions_2 branch from ed21eac to 0a9c7e6 Compare June 18, 2024 22:54
@ziegenberg
Copy link
Contributor Author

Rebased it.

@JakeQZ JakeQZ added the deprecation A method, property, or some functionality has been deprecated. label Jun 19, 2024
Copy link
Contributor

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the OP comment should somehow be included in the CHANGELOG, so that it would be in turn included in the release note, so that people are directed to previous functionality if they want to implement it themselves as a separate libraray. Maybe immediately under the heading ## x.y.z. @oliverklee WDYT?

@JakeQZ JakeQZ requested a review from oliverklee June 19, 2024 01:12
@ziegenberg
Copy link
Contributor Author

Originally I had this comment within the first PR of this series in the Readme.md at the very bottom.

@oliverklee
Copy link
Contributor

I think the OP comment should somehow be included in the CHANGELOG, so that it would be in turn included in the release note, so that people are directed to previous functionality if they want to implement it themselves as a separate libraray.

I think it suffices to have the pair of "deprecate this" and (in the next release) "remove this" in the changelog. This pattern always means for developers to "please stop using this, and use something else instead or stick to an old version" and "the same, but definitely now".

@ziegenberg ziegenberg force-pushed the deprecate-shorthand-functions_2 branch from 0a9c7e6 to 239b1dc Compare June 19, 2024 08:08
@ziegenberg
Copy link
Contributor Author

It's rebased.

@oliverklee oliverklee merged commit 9310f23 into MyIntervals:main Jun 19, 2024
18 checks passed
@ziegenberg ziegenberg deleted the deprecate-shorthand-functions_2 branch June 19, 2024 09:27
oliverklee added a commit that referenced this pull request Sep 10, 2024
This is the backport of #714 and the tickets leading up to that:
- #578
- #580
- #579
- #577
- #576
- #575
- #574
- #573
- #572
- #571
- #570
- #569
- #566
- #567
- #558
oliverklee added a commit that referenced this pull request Sep 10, 2024
This is the backport of #714 and all those changes:

- #578
- #580
- #579
- #577
- #576
- #575
- #574
- #573
- #572
- #571
- #570
- #569
- #566
- #567
- #558
JakeQZ pushed a commit that referenced this pull request Sep 10, 2024
This is the backport of #714 and all those changes:

- #578
- #580
- #579
- #577
- #576
- #575
- #574
- #573
- #572
- #571
- #570
- #569
- #566
- #567
- #558
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation A method, property, or some functionality has been deprecated.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants