-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
Conversation
There was a problem hiding this 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!
docs/framework/additional-apis/system.data.sqltypes.sqlbinary.-ctor.md
Outdated
Show resolved
Hide resolved
docs/framework/additional-apis/system.data.sqltypes.sqlbinary.-ctor.md
Outdated
Show resolved
Hide resolved
docs/framework/additional-apis/system.data.sqltypes.sqlguid.-ctor.md
Outdated
Show resolved
Hide resolved
docs/framework/additional-apis/system.data.sqltypes.sqlguid.-ctor.md
Outdated
Show resolved
Hide resolved
docs/framework/additional-apis/system.data.sqltypes.sqlmoney.-ctor.md
Outdated
Show resolved
Hide resolved
docs/framework/additional-apis/system.data.sqltypes.sqlmoney.-ctor.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@gewarren Had a little bit of trouble finding the TOC file, but I think I got it now. :) |
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 |
Sorry, I should have pointed you to it. It can be tricky to find. |
/cc @dotnet/sqlclientdevteam Please let me know if you have any feedback on these docs before merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Summary
Documents internal ctors for three SQL-related types:
SqlGuid
,SqlBinary
, andSqlDecimal
. 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.