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

Update API docs #22626

Merged
merged 3 commits into from
Sep 24, 2020
Merged

Update API docs #22626

merged 3 commits into from
Sep 24, 2020

Conversation

ajcvickers
Copy link
Member

@ajcvickers ajcvickers requested a review from a team September 20, 2020 18:57
roji
roji approved these changes Sep 20, 2020
View reviewed changes
src/EFCore.Relational/Extensions/RelationalDatabaseFacadeExtensions.cs Outdated Show resolved Hide resolved
src/EFCore.Relational/Extensions/RelationalDatabaseFacadeExtensions.cs Show resolved Hide resolved
src/EFCore.SqlServer/Migrations/SqlServerMigrationsSqlGenerator.cs Outdated Show resolved Hide resolved
src/EFCore/ChangeTracking/ChangeTracker.cs Show resolved Hide resolved
src/EFCore/ChangeTracking/EntityEntryGraphNode.cs Show resolved Hide resolved
src/EFCore/DbContextOptionsBuilder`.cs Show resolved Hide resolved
src/EFCore/EF.cs Outdated Show resolved Hide resolved
src/EFCore/Infrastructure/DatabaseFacade.cs Outdated Show resolved Hide resolved
src/EFCore/Infrastructure/DatabaseFacade.cs Outdated Show resolved Hide resolved
src/EFCore/Infrastructure/DatabaseFacade.cs Outdated Show resolved Hide resolved
@smitpatel
Copy link
Member

Helix error

xUnit.net Console Runner v2.4.1 (64-bit .NET 5.0.0-rc.1.20451.14)
  Discovering: Microsoft.EntityFrameworkCore.Analyzers.Tests
  Discovered:  Microsoft.EntityFrameworkCore.Analyzers.Tests
  Starting:    Microsoft.EntityFrameworkCore.Analyzers.Tests
    Microsoft.EntityFrameworkCore.InternalUsageDiagnosticAnalyzerTest.Instantiation_on_type_in_internal_namespace [FAIL]
      Assert.Empty() Failure
      Collection: [Test.cs(7,5): error CS0246: The type or namespace name 'CoreSingletonOptions' could not be found (are you missing a using directive or an assembly reference?)]
      Stack Trace:
        F:\workspace\_work\1\s\test\EFCore.Analyzers.Tests\TestUtilities\DiagnosticAnalyzerTestBase.cs(57,0): at EFCore.Analyzers.Test.TestUtilities.DiagnosticAnalyzerTestBase.GetDiagnosticsFullSourceAsync(String source)
        F:\workspace\_work\1\s\test\EFCore.Analyzers.Tests\TestUtilities\DiagnosticAnalyzerTestBase.cs(49,0): at EFCore.Analyzers.Test.TestUtilities.DiagnosticAnalyzerTestBase.GetDiagnosticsAsync(String source, String[] extraUsings)
        F:\workspace\_work\1\s\test\EFCore.Analyzers.Tests\InternalUsageDiagnosticAnalyzerTest.cs(206,0): at Microsoft.EntityFrameworkCore.InternalUsageDiagnosticAnalyzerTest.Test(String source, String expectedInternalApi, String expectedDiagnosticSpan)
        --- End of stack trace from previous location ---
  Finished:    Microsoft.EntityFrameworkCore.Analyzers.Tests
=== TEST EXECUTION SUMMARY ===
   Microsoft.EntityFrameworkCore.Analyzers.Tests  Total: 15, Errors: 0, Failed: 1, Skipped: 0, Time: 7.244s

@ajcvickers
Update API docs
1fe4729 
* Document connection obtained from DatabaseFacade.GetDbConnection() should normally not be disposed Fixes #11415
* Add XML docs referencing how to determine the default CommandTimeout Fixes #17503
* Clarify behavior for EnsureExists with an empty database Fixes #17563
* A hyperlink to the DbContext.Database.Migrate() method would be useful Fixes #17571
* Default values for maxRetryCount, maxRetryDelay, and errorNumbersToAdd Fixes #17574
* Document that modifying entity states while iterating over entries can result in "Collection was modified" exception Fixes #18389
* Update API doc links to correctly reference external dependencies Fixes #18580
* Make it clearer how to access EF.Functions Fixes #21424
* Improve API docs for TrackGraph Fixes #22529
@ajcvickers
Review feedback
4172bf9
@roji roji mentioned this pull request Sep 21, 2020
Closed
@ajcvickers @roji
Update src/EFCore/EF.cs
186a974 
Co-authored-by: Shay Rojansky <roji@roji.org>
smitpatel
smitpatel reviewed Sep 24, 2020
View reviewed changes
src/EFCore/EF.cs
@@ -21,8 +21,7 @@ public static partial class EF

/// <summary>
/// <para>
/// Addresses a given property on an entity instance. This is useful when you want to reference a shadow state property in a
/// LINQ query. Currently this method can only be used in LINQ queries and can not be used to access the value assigned to a
/// References a given property on an entity instance. This is useful for shadow state properties, for which no CLR property exists. Currently this method can only be used in LINQ queries and can not be used to access the value assigned to a
Copy link
Member

Choose a reason for hiding this comment

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

It can also reference navigation skip navigation.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will do in another PR.

@ajcvickers ajcvickers merged commit f4403c9 into main Sep 24, 2020
@ajcvickers ajcvickers deleted the APoxOnTheDox0920 branch September 24, 2020 17:04
@ajcvickers ajcvickers mentioned this pull request Oct 1, 2020
Closed
@ajcvickers ajcvickers modified the milestones: 6.0.0, 5.0.0 Nov 25, 2020
@ajcvickers ajcvickers removed this from the 5.0.0 milestone Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@smitpatel smitpatel smitpatel left review comments

@roji roji roji approved these changes

@AndriySvyryd AndriySvyryd AndriySvyryd left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@ajcvickers @smitpatel @roji @AndriySvyryd