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

Improve API docs for TrackGraph #22529

Closed
ajcvickers opened this issue Sep 14, 2020 · 0 comments · Fixed by #22626
Closed

Improve API docs for TrackGraph #22529

ajcvickers opened this issue Sep 14, 2020 · 0 comments · Fixed by #22626
Labels
area-change-tracking area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported type-enhancement
Milestone
6.0.0

Comments

@ajcvickers
Copy link
Member

From #8226 (comment)

Asking for an improvement in the documentation (https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.changetracking.entityentrygraphnode-1.nodestate?view=efcore-3.1#Microsoft_EntityFrameworkCore_ChangeTracking_EntityEntryGraphNode_1_NodeState).

  • Need to state that the callback should return true to continue iteration to nodes reachable from the current node, or false to not iterate on nodes that are reachable from the current node (other than, presumably, nodes that have already been visited).
  • Need to explain that the state information is passed to the callback indirectly, in the NodeState property of the EntityEntryGraphNode<TState>.
  • Need to explain the difference between the Entry and SourceEntry properties of the EntityEntryGraphNode<TState>.
@ajcvickers ajcvickers added this to the MQ milestone Sep 14, 2020
@ajcvickers ajcvickers self-assigned this Sep 14, 2020
@ajcvickers ajcvickers added the closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. label Sep 20, 2020
ajcvickers added a commit that referenced this issue Sep 20, 2020
@ajcvickers
Update API docs
d18cb89 
* 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 ajcvickers mentioned this issue Sep 20, 2020
Merged
ajcvickers added a commit that referenced this issue Sep 21, 2020
@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 added a commit that referenced this issue Sep 24, 2020
@ajcvickers @roji
Update API docs (#22626)
f4403c9 
* Update API docs

* 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

* Review feedback

* Update src/EFCore/EF.cs

Co-authored-by: Shay Rojansky <roji@roji.org>

Co-authored-by: Shay Rojansky <roji@roji.org>
@ajcvickers ajcvickers modified the milestones: MQ, 6.0.0 Nov 25, 2020
@ajcvickers ajcvickers modified the milestones: 6.0.0, 6.0.0-preview1 Jan 27, 2021
@ajcvickers ajcvickers modified the milestones: 6.0.0-preview1, 6.0.0 Nov 8, 2021
@ajcvickers ajcvickers removed their assignment Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-change-tracking area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported type-enhancement
Projects
None yet
Milestone
6.0.0
Development

Successfully merging a pull request may close this issue.

Update API docs dotnet/efcore
1 participant
@ajcvickers