Skip to content

docs: [2.X] fixes of PVP exceptions #3225

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

docs: [2.X] fixes of PVP exceptions #3225

merged 8 commits into from
Mar 24, 2025

Conversation

michalChrobot
Copy link
Collaborator

@michalChrobot michalChrobot commented Feb 5, 2025

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 currently have 768 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

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!

@michalChrobot michalChrobot self-assigned this Feb 5, 2025
@NoelStephensUnity NoelStephensUnity changed the title chore: fixes of PVP-151-1 fix: fixes of PVP-151-1 Feb 7, 2025
@michalChrobot michalChrobot changed the title fix: fixes of PVP-151-1 docs: fixes of PVP-151-1 Feb 11, 2025
@michalChrobot michalChrobot changed the title docs: fixes of PVP-151-1 docs: fixes of PVP exceptions Feb 17, 2025
@michalChrobot michalChrobot changed the title docs: fixes of PVP exceptions docs: [2.X] fixes of PVP exceptions Feb 17, 2025
@michalChrobot michalChrobot marked this pull request as ready for review March 21, 2025 15:20
@michalChrobot michalChrobot requested a review from a team as a code owner March 21, 2025 15:20
@EmandM EmandM merged commit cab4d78 into develop-2.0.0 Mar 24, 2025
27 checks passed
@EmandM EmandM deleted the PVP-151-fix branch March 24, 2025 19:36
NoelStephensUnity pushed a commit that referenced this pull request Apr 11, 2025
This PR is a continuation of
#3225
and 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 currently have 137 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

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.

**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
tests (so TestHelpers, EditorTests, RuntimeTests) because those are not
affecting users in any way.

## Backport 
This PR has its equivalent in the sense of
#3374
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