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

Document some internal SQL type ctors as additional-apis #28911

Merged
merged 3 commits into from
Apr 6, 2022

Conversation

GrabYourPitchforks
Copy link
Member

Summary

Documents internal ctors for three SQL-related types: SqlGuid, SqlBinary, and SqlDecimal. The out-of-band package Microsoft.Data.SqlClient currently uses unsupported union overlays to access these types (see dotnet/runtime#51836). We can update the code to use a less fragile private reflection pattern, but it first requires properly documenting these APIs under the additional-apis subfolder.

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

We usually code fence parameter names so they don't get localized. Also, can you add the 3 new files to the TOC? Thank you!

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@GrabYourPitchforks
Copy link
Member Author

@gewarren Had a little bit of trouble finding the TOC file, but I think I got it now. :)
Let me know if anything else is missing! I appreciate your eagle eyes on this.

@GrabYourPitchforks
Copy link
Member Author

Note: I used "structure" instead of "class" to match precedent already in the additional-apis section of the TOC.

  - name: stdole namespace
    items:
    - name: DISPPARAMS structure
      href: additional-apis/stdole.dispparams.md
    - name: EXCEPINFO structure
      href: additional-apis/stdole.excepinfo.md

@gewarren
Copy link
Contributor

gewarren commented Apr 5, 2022

@gewarren Had a little bit of trouble finding the TOC file, but I think I got it now. :)

Sorry, I should have pointed you to it. It can be tricky to find.

@GrabYourPitchforks
Copy link
Member Author

/cc @dotnet/sqlclientdevteam Please let me know if you have any feedback on these docs before merge.

Copy link

@David-Engel David-Engel left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants