Update API docs #22626

ajcvickers · 2020-09-20T18:57:49Z

Document connection obtained from DatabaseFacade.GetDbConnection() should normally not be disposed Fixes Document connection obtained from DatabaseFacade.GetDbConnection() should normally not be disposed #11415
Add XML docs referencing how to determine the default CommandTimeout Fixes Add XML docs referencing how to determine the default CommandTimeout #17503
Clarify behavior for EnsureExists with an empty database Fixes Clarify behavior for EnsureExists with an empty database #17563
A hyperlink to the DbContext.Database.Migrate() method would be useful Fixes A hyperlink to the DbContext.Database.Migrate() method would be useful #17571
Default values for maxRetryCount, maxRetryDelay, and errorNumbersToAdd Fixes Default values for maxRetryCount, maxRetryDelay, and errorNumbersToAdd #17574
Document that modifying entity states while iterating over entries can result in "Collection was modified" exception Fixes Document that modifying entity states while iterating over entries can result in "Collection was modified" exception #18389
Update API doc links to correctly reference external dependencies Fixes Update API doc links to correctly reference external dependencies #18580
Make it clearer how to access EF.Functions Fixes Make it clearer how to access EF.Functions #21424
Improve API docs for TrackGraph Fixes Improve API docs for TrackGraph #22529

src/EFCore.Relational/Extensions/RelationalDatabaseFacadeExtensions.cs

src/EFCore.SqlServer/Migrations/SqlServerMigrationsSqlGenerator.cs

src/EFCore/ChangeTracking/ChangeTracker.cs

src/EFCore/ChangeTracking/EntityEntryGraphNode.cs

src/EFCore/DbContextOptionsBuilder`.cs

src/EFCore/EF.cs

src/EFCore/Infrastructure/DatabaseFacade.cs

smitpatel · 2020-09-21T02:57:20Z

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

* 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

Co-authored-by: Shay Rojansky <[email protected]>

smitpatel · 2020-09-24T00:17:51Z

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


It can also reference navigation skip navigation.

Will do in another PR.

ajcvickers requested a review from a team September 20, 2020 18:57

roji approved these changes Sep 20, 2020

View reviewed changes

ajcvickers added 2 commits September 21, 2020 09:24

Review feedback

4172bf9

ajcvickers force-pushed the APoxOnTheDox0920 branch from d18cb89 to 4172bf9 Compare September 21, 2020 16:40

roji mentioned this pull request Sep 21, 2020

Link conceptual documentation from API docs #17508

Closed

Update src/EFCore/EF.cs

186a974

Co-authored-by: Shay Rojansky <[email protected]>

smitpatel reviewed Sep 24, 2020

View reviewed changes

ajcvickers merged commit f4403c9 into main Sep 24, 2020

ajcvickers deleted the APoxOnTheDox0920 branch September 24, 2020 17:04

ajcvickers mentioned this pull request Oct 1, 2020

Entity Framework Weekly Status Updates (2020) #19549

Closed

ajcvickers modified the milestones: 6.0.0, 5.0.0 Nov 25, 2020

ajcvickers removed this from the 5.0.0 milestone Dec 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update API docs #22626

Update API docs #22626

ajcvickers commented Sep 20, 2020

smitpatel commented Sep 21, 2020

smitpatel Sep 24, 2020

ajcvickers Sep 24, 2020

Update API docs #22626

Update API docs #22626

Conversation

ajcvickers commented Sep 20, 2020

smitpatel commented Sep 21, 2020

smitpatel Sep 24, 2020

Choose a reason for hiding this comment

ajcvickers Sep 24, 2020

Choose a reason for hiding this comment