Skip to content

[DOCS] Add an API and deprecation policy #720

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
merged 3 commits into from
Sep 18, 2024
Merged

Conversation

oliverklee
Copy link
Collaborator

As discussed here:
#715

Copy link
Collaborator

@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.

Just some typos in one sentence.

It occurs to me that we ourselves need to track when we mark something as @internal to ensure we don't make make any breaking changes before the next major release since doing so. I don't know if we can use something like "@internal may be changed or removed without notice from version 9.0.0" in the PHPDoc. This doesn't affect this PR, I'm just concerned that we might for example start making breaking changes to a class marked as @internal for 8.7 for a bugfix which is then included in 8.7.1, not realizing (or forgetting) it had not been marked @internal in 8.6.

Co-authored-by: JakeQZ <jake@qzdesign.co.uk>
@coveralls
Copy link

coveralls commented Sep 18, 2024

Coverage Status

coverage: 38.652%. remained the same
when pulling 05b2be1 on docs/api-deprecation-policy
into 97cc5e4 on main.

@oliverklee oliverklee requested a review from JakeQZ September 18, 2024 08:06
@JakeQZ JakeQZ merged commit 18120ca into main Sep 18, 2024
20 checks passed
@JakeQZ JakeQZ deleted the docs/api-deprecation-policy branch September 18, 2024 17:08
oliverklee added a commit to MyIntervals/emogrifier that referenced this pull request Sep 19, 2024
This is exactly the same change as in our sister project,
PHP-CSS-Parser:

MyIntervals/PHP-CSS-Parser#720
oliverklee added a commit to MyIntervals/emogrifier that referenced this pull request Sep 19, 2024
This is exactly the same change as in our sister project,
PHP-CSS-Parser:

MyIntervals/PHP-CSS-Parser#720
oliverklee added a commit to MyIntervals/emogrifier that referenced this pull request Sep 19, 2024
This is exactly the same change as in our sister project,
PHP-CSS-Parser:

MyIntervals/PHP-CSS-Parser#720
JakeQZ pushed a commit to MyIntervals/emogrifier that referenced this pull request Sep 19, 2024
This is exactly the same change as in our sister project,
PHP-CSS-Parser:

MyIntervals/PHP-CSS-Parser#720
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants