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.

Sign up for GitHub

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

Jump to bottom

Fix | Refine documents for GA v5.2 #2371

Merged
merged 6 commits into from Feb 27, 2024
Merged

Fix | Refine documents for GA v5.2 #2371

merged 6 commits into from Feb 27, 2024

Conversation

DavoudEshtehari
Copy link
Member

@DavoudEshtehari DavoudEshtehari commented Feb 26, 2024 •
edited

  • Added missing public APIs.
  • Removed the use of inheritdoc due to its lack of support for cross-repository references and a few issues with the documentation engine.
  • Removed redundant XML files.
  • Followed the XML file pattern and standardized documentation.
  • Made a few documentation improvements.

Smoke-test

@DavoudEshtehari
Squashed commit of the following:
6350542 
commit 0ec519b
Merge: 94b4384 e3cf59d
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 15 11:59:28 2024 -0800

    Merge branch 'dotnet:main' into Task-28274-Update-API-Documentation

commit 94b4384
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 16:30:55 2024 -0800

    Reviewed Intellisense

    Just clean-up, and removing the extra space between sentences.

commit 79d979e
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 16:24:22 2024 -0800

    Update SqlBatch.xml

    Remove namespaces that are breaking the documentation generator

commit 8e5d837
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 14:09:01 2024 -0800

    Corrections to Namespace/Wrong Attributes

    Remove DbBatchCommandCollection

commit a0af3d6
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 08:36:08 2024 -0800

    Correct Case Mistakes

commit f6c994f
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 08:33:53 2024 -0800

    Correct some missing documentation

    Missing tag headings

commit 1cc876e
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 13 08:24:12 2024 -0800

    Manual Copy Paste of DBBatch version replacements

    Copy manual DB Batch (parent Class Documentation)

commit c7fd5f1
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Feb 12 17:20:08 2024 -0800

    Duplicate Features from DbBatch

commit 0e8e54a
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 8 13:08:29 2024 -0800

    SQLBatchCommandCollection Changes

    Update to InheritDoc for SQLBatchCommandCollection

commit a894493
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 8 10:20:53 2024 -0800

    Update Batch documentation with InheritDoc and Resolved Paths

    Re-generate NuGet API Documentation with InheritDoc Changes for cref References

commit 040df88
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Feb 7 16:28:41 2024 -0800

    Clean-up / Experiment 2

    Remove DB Batch XML references, this documentation is not supported by this repository. Update smaller changes on Document inheritance, and find the correct formatting for usage. Existing inheritdoc references don't seem to be aligning very closely to their reference base classes.

commit 3ca9b7e
Merge: eed5b4b 507e8dd
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Feb 7 09:11:06 2024 -0800

    Merge branch 'main' into Task-28274-Update-API-Documentation

commit eed5b4b
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Feb 7 09:05:10 2024 -0800

    Explicit Declaration for SQLBatch and SQLBatchCommandCollection

    For InheritDoc, Explicit declaration of where the reference is located.

commit 5d2cfd7
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 6 13:36:38 2024 -0800

    Test Experimental Changes for API Documentation

commit 20bacb0
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Feb 6 10:22:55 2024 -0800

    Update Conditions for all .NetCore

commit 2c95099
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Feb 5 17:21:29 2024 -0800

    Missing PrepareAsync

commit cf03fb0
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Feb 5 09:00:05 2024 -0800

    Check if there's an Easier way to use InheritDoc

    Verify Different way of using InheritDoc will allow usage as attribute header.

commit a1e5a1f
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Feb 2 10:39:22 2024 -0800

    IList looks like the correct namespace

    Update namespace

commit 42611b5
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Feb 2 09:26:12 2024 -0800

    Missing Definition for Property

commit 17a95bb
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Feb 2 09:21:04 2024 -0800

    Clean-up Mix up for Property vs Methods

commit 66ad6a5
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 1 16:23:33 2024 -0800

    Fix SqlBatch API Documentation - For Consistency Verification Against MS Doc Generation

commit 17c86d4
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 1 11:02:46 2024 -0800

    Correct mistake on references

    Clean-up Connection Reference Mistake.

commit 0a56b25
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 1 10:38:53 2024 -0800

    Test Possible Corrections on "Cross Reference Not Found" for System.Collection and "Found no member can be inherited by key"

commit 0afee4c
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Feb 1 08:11:11 2024 -0800

    Correct NameSpace

commit 6779d29
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 31 14:40:05 2024 -0800

    Revert "Test Change in Pragma Directives"

    This reverts commit 17f22ba.

commit 4fe316e
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 31 14:32:52 2024 -0800

    Fix mistake on format

    Correct format Type

commit 17f22ba
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 31 13:50:49 2024 -0800

    Test Change in Pragma Directives

    Change conditions, so that the class handles necessary changes

commit c4a7a54
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 31 13:07:28 2024 -0800

    Undo Incorrect Pathing - Physical Location

    VS Representation is not the same as physical location

commit 04b25db
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Jan 30 15:53:45 2024 -0800

    Reference Paths Seem busted

    Pathing looks messed up

commit 8036b9d
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Jan 30 08:42:30 2024 -0800

    Remove reference to System.Collections.Generic.IEnumerable.

commit f512737
Merge: bb3103c 14d7292
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Tue Jan 30 08:28:57 2024 -0800

    Merge branch 'main' into Task-28274-Update-API-Documentation

    # Conflicts:
    #	doc/snippets/Microsoft.Data.SqlClient/SqlException.xml

commit bb3103c
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 29 16:35:50 2024 -0800

    Wrong Namespace was used, Git rid of Extra Space, using the name of SqlBatch instead of Xref, just to see if the error will go away. Then figure out why Xref SQLBatch keeps failing as a reference, which might be a separate problem for documentation outside of the actual SQLBatch. It may be not able to properly get the XREF from a different file.

commit 6afbd49
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 29 15:04:38 2024 -0800

    Missing Documentation for Context on Page.

    https://review.learn.microsoft.com/en-us/dotnet/api/microsoft.data.sqlclient?view=sqlclient-dotnet-5.2&branch=pr-en-us-69

commit 135e4ea
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 29 13:06:42 2024 -0800

    Revert SqlBatch test

    Test other Ienumerable fix

commit 567ff89
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 29 09:07:02 2024 -0800

    Try to Resolve Batch/IEnumerable Errors

    Making slightly changes on which signature needs to be added to resolve errors.

commit 9608bbd
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Jan 26 17:11:31 2024 -0800

    Include SqlBatch Reference

    Need to test if this reference is required, as it appears to be missing.

commit b828a47
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Jan 26 13:20:16 2024 -0800

    Reference BatchCommand

    Update Inherit doc cref references.

commit ca05e53
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Jan 26 11:48:56 2024 -0800

    Resolving Path References

    Working to resolve Path References

commit 0823b74
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 22 08:44:35 2024 -0800

    Update XML Reference

    Looks like references to XREF paths in documentations require a specific XML pattern.

commit e47715c
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Fri Jan 19 15:31:20 2024 -0800

    Updates to SqlBatchCommand PR failures

commit 532ed2a
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Thu Jan 18 08:43:18 2024 -0800

    Add a Change for Nuget on Updating SqlException - Match Javad's work.

commit b881127
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 17 16:01:12 2024 -0800

    Do Delta Differences

    Make changes, where one has an explicit definition in the .cs file/xml;
    While the other uses <inheritdoc>, based on the System.... series of libraries.

commit 9c4e0df
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 17 13:54:53 2024 -0800

    Partial Changes

    This is the first attempt to partially align formatting to the original way of doing things by marking up headers, prior to implementation of inheritdoc of base classes.

commit c99502c
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Wed Jan 17 10:40:55 2024 -0800

    Restore <inheritdoc> tags

commit afe0ee4
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 15 14:41:06 2024 -0800

    Small Test - Inherit Doc verification to XML

    Following guided instructions, testing incrementally whether this is correct. Which appears to be sort of working based on compiled Microsoft XML document (no errors).

commit 1495903
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 15 14:06:19 2024 -0800

    Restore

    Based on documentation, inheritdoc should not be used here.

commit 12623b0
Author: H. Yeo <138053434+H-Yeo@users.noreply.github.com>
Date:   Mon Jan 15 13:24:00 2024 -0800

    Update SqlBatchCommand Class

    Starting with Update of SqlBatchCommand class document header
@DavoudEshtehari
SqlBatch - use inheritdoc in xml file
c42654c
@DavoudEshtehari
SqlBatchCommand - use inheritdoc in xml file
1538888
@DavoudEshtehari
SqlBatchCommandCollection - use inheritdoc in xml file
4b74322
@DavoudEshtehari
Take out inheritdoc
e340f93
@DavoudEshtehari
fix
43a1a04
@DavoudEshtehari DavoudEshtehari added 🆕 Public API Use this label for new API additions to the driver. 📃 Documentation Use this label for any documentation changes labels Feb 26, 2024
@DavoudEshtehari DavoudEshtehari added this to the 5.2.0 milestone Feb 26, 2024
@codecov Codecov
Copy link

codecov bot commented Feb 27, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 72.58%. Comparing base (e3cf59d) to head (43a1a04).
Report is 5 commits behind head on main.

Files Patch % Lines
...SqlClient/src/Microsoft/Data/SqlClient/SqlBatch.cs 0.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2371      +/-   ##
==========================================
- Coverage   72.67%   72.58%   -0.09%     
==========================================
  Files         310      310              
  Lines       61875    61875              
==========================================
- Hits        44965    44912      -53     
- Misses      16910    16963      +53
Flag Coverage Δ
addons 92.88% <ø> (ø)
netcore 76.80% <0.00%> (-0.14%) ⬇️
netfx 70.14% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JRahnama JRahnama merged commit 10c9e17 into dotnet:main Feb 27, 2024
148 checks passed
@DavoudEshtehari DavoudEshtehari mentioned this pull request Feb 27, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@David-Engel David-Engel David-Engel approved these changes

@JRahnama JRahnama JRahnama approved these changes

Assignees
No one assigned
Labels
🆕 Public API Use this label for new API additions to the driver. 📃 Documentation Use this label for any documentation changes
Projects
None yet
Milestone
5.2.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@DavoudEshtehari @David-Engel @JRahnama