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.

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

chore: deprecate respecIsReady in favor of respec.ready #3090

Merged
merged 6 commits into from
Oct 29, 2020

Conversation

sidvishnoi
Copy link
Member

@sidvishnoi sidvishnoi commented Aug 25, 2020

  • Do not yet remove document.respecIsReady, mark as deprecated only.
  • BREAKING CHANGE: respecIsReady no longer resolves with respecConfig.
  • Replace all usage of document.respecIsReady with document.respec.ready.
  • Support respecIsReady fallback in respecDocWriter for backward compat.

Part of https://github.com/w3c/respec/issues/3089. Also see https://github.com/w3c/respec/pull/3082#discussion_r475473908

- Do not yet remove document.respecIsReady, mark as deprecated only.
- BREAKING CHANGE: respecIsReady no longer resolves with respecConfig.
- Replace all usage of respecIsReady with respec.ready.
- Support respecIsReady fallback in respecDocWriter for backward compat.
@sidvishnoi sidvishnoi mentioned this pull request Aug 25, 2020
6 tasks
@sidvishnoi
Copy link
Member Author

Only remaining occurrences of respecIsReady:
image

Copy link
Collaborator

@saschanaz saschanaz left a comment

Choose a reason for hiding this comment

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

I'm late but 👍

@sidvishnoi
Copy link
Member Author

sidvishnoi commented Oct 26, 2020

I wonder if we should mark is as breaking change. Based on my GitHub search, I didn't find anyone using the resolved respecConfig from document.respecIsReady, which is the only breaking change in this PR.
If we mark it as breaking change, I would prefer to merge it with other breaking changes later.

@marcoscaceres
Copy link
Contributor

Up to you - but this seems pretty safe to merge.

@saschanaz
Copy link
Collaborator

IMO a breaking change is a breaking change, even when seemingly there is no real use anymore. But up to you, yes.

@sidvishnoi
Copy link
Member Author

Lets merge this as non-breaking 🤞

@sidvishnoi sidvishnoi changed the title BREAKING CHANGE: deprecate respecIsReady in favor of respec.ready chore: deprecate respecIsReady in favor of respec.ready Oct 29, 2020
@sidvishnoi sidvishnoi merged commit 444982f into develop Oct 29, 2020
@sidvishnoi sidvishnoi deleted the deprecate-respecIsReady branch October 29, 2020 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants