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

Clean up EntityMetaData and fix incorrect release tags #7034

Open
wants to merge 24 commits into
base: master
Choose a base branch
from

Conversation

pmconne
Copy link
Member

@pmconne pmconne commented Aug 2, 2024

Part of https://github.com/iTwin/itwinjs-backlog/issues/1103.

This was one of the very first APIs ever created for iTwin.js and boy does it show.
Despite still being tagged as @beta after all these years, it has always been de facto part of the @public API due to its use in @public methods like Entity.forEachProperty and Element.getClassMetaData. (api-extractor does not check ae-incompatible-release-tags across package boundaries).

I tried to do minimal cleanup without introducing breaking changes and add/clarify documentation. Mostly I preferred to link to the learning articles in docs/bis/ec; those need some separate cleanup, though.

@pmconne
Copy link
Member Author

pmconne commented Aug 2, 2024

@khanaffan @ColinKerr @diegoalexdiaz please fact-check my documentation.

@pmconne pmconne marked this pull request as ready for review August 2, 2024 12:41
@ColinKerr
Copy link
Member

Can we take a look at how this stuff is actually used before we promote to public?

@pmconne
Copy link
Member Author

pmconne commented Aug 2, 2024

Can we take a look at how this stuff is actually used before we promote to public?

We can, but I want to reiterate: it is already public and has been for years, beta tag notwithstanding.
Booster's usage.

@pmconne pmconne changed the title Clean up and promote EntityMetaData Clean up EntityMetaData and fix incorrect release tags Aug 2, 2024
Copy link
Contributor

mergify bot commented Aug 6, 2024

This pull request is now in conflicts. Could you fix it @pmconne? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

@pmconne pmconne enabled auto-merge (squash) August 6, 2024 22: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.

4 participants