Skip to content

docs: [1.X] fixes of PVP exceptions #3300

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 18 commits into from
Mar 24, 2025
Merged

docs: [1.X] fixes of PVP exceptions #3300

merged 18 commits into from
Mar 24, 2025

Conversation

michalChrobot
Copy link
Collaborator

This PR focuses on fixing PVP errors related to PVP-151-1 "Public APIs should be documented" and all remaining PVP errors present in pvpExceptions.json file

We have quite a lot of errors to address so this PR will be a collaborative effort. If anyone want's to add to it what we should do is:

  1. Check errors present in pvpExceptions.json file (preferably under "PVP-150-1", choose some to fix
  2. Address those errors and when making commit remove the fixed errors from pvpExceptions file
    The first commit of this PR is an example of how such process should look like

In general new CI implementation will catch all new errors like this so all we need to do is fix the present ones. This PR does not focus on PVP present in gold profile but if capacity allows, those can also be addressed.

Error present in "PVP-41-1" is to be expected so there is no need of fixing this one!

Another thing is that we could ignore error related to missing APIs for RuntimeTests because those were made internal in 2.X version (that's why those errors are not popping by there). Those APIs are not user facing so we could just leave them (otherwise there is like 2000 more APIs to add)

@michalChrobot michalChrobot self-assigned this Feb 17, 2025
@michalChrobot michalChrobot marked this pull request as ready for review March 21, 2025 15:21
@EmandM EmandM merged commit ced4384 into develop Mar 24, 2025
40 checks passed
@EmandM EmandM deleted the pvp-fixes-develop branch March 24, 2025 19:36
NoelStephensUnity added a commit that referenced this pull request Jun 24, 2025
This PR is a continuation of
#3300
It focuses on fixing PVP errors related to PVP-151-1 "**_Public APIs
should be documented_**" and all remaining PVP errors **present in
pvpExceptions.json file**

We have 87 errors left from PVP-151-1 at the time of this PR creation.
If anyone want's to add to it what we should do is:

1. Check errors present in pvpExceptions.json file (preferably under
"PVP-150-1", choose some to fix
2. Address those errors and when making commit remove the fixed errors
from pvpExceptions file
The first commit of this PR is an example of how such process should
look like

In general [new CI
implementation](#3193)
will catch all new errors like this so all we need to do is fix the
present ones. This PR **does not** focus on PVP present in gold profile
but if capacity allows, those can also be addressed.

**Errors present in "PVP-41-1", "PVP-300-4" are to be expected** so
there is no need of fixing this one!
Another thing is that we could ignore error related to missing APIs for
tests (so TestHelpers, EditorTests, RuntimeTests) because those were
made internal in 2.X version (that's why those errors are not popping by
there). This does not affect users so we don't need to add anything
there

## Backport 
This has its equivalent in
#3375

---------

Co-authored-by: Emma <[email protected]>
Co-authored-by: Noel Stephens <[email protected]>
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