docs: [1.X] fixes of PVP exceptions (round 2) #3374
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ologies/com.unity.netcode.gameobjects into pvp-fixes-develop-v2
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
Adjusting constructor and destructor XML API.
Minor adjustment to XML API
Adding period at end of each param XML API description.
adding period in XML API update.
adding period to end of sentences for XML API.
minor adjustments to XML API update.
minor XML API update.
NoelStephensUnity
approved these changes
Jun 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.
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