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

fix: fixes of PVP-150-1 #3223

Open
wants to merge 4 commits into
base: develop-2.0.0
Choose a base branch
from
Open

Conversation

michalChrobot
Copy link
Contributor

@michalChrobot michalChrobot commented Feb 4, 2025

This PR focuses on fixing errors related to PVP-150-1 "XmlDoc should be valid"

At the beginning I wanted to fix both PVP-150-1 as well as PVP-151-1 in one PR but I came to the conclusion that it's better to separate those because of the amount of changes to be checked for correctness.

There were several places (like for example FastBufferWriter/FastBufferReader) where XmlDoc was describing unused parameter <param name="unused">An unused parameter used for enabling overload resolution based on generic constraints</param>, we should ensure that it's correct that said argument is not used by the given APIs

@michalChrobot michalChrobot self-assigned this Feb 4, 2025
@michalChrobot michalChrobot marked this pull request as ready for review February 5, 2025 12:00
@michalChrobot michalChrobot requested review from a team as code owners February 5, 2025 12:00
@michalChrobot michalChrobot changed the title Fixes of PVP-150-1 chore: fixes of PVP-150-1 Feb 5, 2025
Updating some of the missing XML API documentation.
Copy link
Collaborator

@NoelStephensUnity NoelStephensUnity left a comment

Choose a reason for hiding this comment

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

I think we are still missing some XML documentation, but this is a very good start!
🥇

@michalChrobot
Copy link
Contributor Author

I did it based on PVP exceptions I saw in the file, it may happen that some new places were introduced since I created this branch. That's why I would like to merge CI changes (LINK) first since this will detect (and block) any new "introduction of related errors" so we can make sure we are addressing all XmlDoc issues (this is different from API docs and there will be a separate PR for those (LINK), it's still work in progress though, I may have it next week)

@michalChrobot michalChrobot added the port:1.x-needed This issue needs to be ported to 1.X branch label Feb 7, 2025
@NoelStephensUnity NoelStephensUnity changed the title chore: fixes of PVP-150-1 fix: fixes of PVP-150-1 Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
port:1.x-needed This issue needs to be ported to 1.X branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants