Skip to content

Add docs for Session, Diagnostics.EntityFrameworkCore, MiddlewareAnalysis and HeaderPropagation #26720

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
Merged
merged 7 commits into from
Oct 10, 2020
Merged

Add docs for Session, Diagnostics.EntityFrameworkCore, MiddlewareAnalysis and HeaderPropagation #26720

merged 7 commits into from
Oct 10, 2020

Conversation

halter73
Copy link
Member

@halter73 halter73 commented Oct 9, 2020

Partially addresses #26397

@halter73 halter73 added area-middleware tell-mode Indicates a PR which is being merged during tell-mode labels Oct 9, 2020
@halter73 halter73 added this to the 5.0.0 milestone Oct 9, 2020
@halter73
Copy link
Member Author

halter73 commented Oct 9, 2020

@jkotalik @BrennanConroy @wtgodbe Can one of you quickly review and approve this? I think today is the last day to merge API docs to release/5.0.

jkotalik
jkotalik reviewed Oct 9, 2020
View reviewed changes
src/Middleware/Diagnostics.EntityFrameworkCore/src/DatabaseDeveloperPageExceptionFilter.cs
/// <summary>
/// Handle <see cref="DbException"/> errors and output an HTML response with additional details.
/// </summary>
/// <inheritdoc />
Copy link
Contributor

Choose a reason for hiding this comment

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

What happens with inheritdoc and a summary? Should you just have inheritdoc?

Copy link
Member Author

Choose a reason for hiding this comment

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

Seems to work:

image

image

This was tough to verify, because it stays as /// <inheritdoc /> inside the compiled dll.

image

While investigating this I ran across the issue you filed (#26434) about inherited docs not showing up on docs.microsoft.com. Good catch.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah that gotta be fixed.

Copy link
Contributor

Choose a reason for hiding this comment

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

But glad that works!

jkotalik
jkotalik reviewed Oct 9, 2020
View reviewed changes
BrennanConroy
BrennanConroy reviewed Oct 9, 2020
View reviewed changes
BrennanConroy
BrennanConroy reviewed Oct 9, 2020
View reviewed changes
src/Middleware/Session/src/DistributedSession.cs
public async Task LoadAsync(CancellationToken cancellationToken = default)
{
// This will throw if called directly and a failure occurs. The user is expected to handle the failures.
Copy link
Member

Choose a reason for hiding this comment

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

Make this a remark?

Copy link
Member Author

Choose a reason for hiding this comment

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

I almost did until I looked at the doc we're inheriting and saw it's already called out.

aspnetcore/src/Http/Http.Features/src/ISession.cs

Lines 28 to 32 in 25bd01f

/// <summary>
/// Load the session from the data store. This may throw if the data store is unavailable.
/// </summary>
/// <returns></returns>
Task LoadAsync(CancellationToken cancellationToken = default(CancellationToken));

BrennanConroy
BrennanConroy reviewed Oct 9, 2020
View reviewed changes
@halter73
Copy link
Member Author

halter73 commented Oct 10, 2020 •
edited
Loading

@Pilchie I'm using my build ops powers to merge this before tell mode technically ends.

@halter73 halter73 merged commit ff6d198 into release/5.0 Oct 10, 2020
@halter73 halter73 deleted the halter73/26397 branch October 10, 2020 03:38
TanayParikh added a commit that referenced this pull request Oct 14, 2020
@dotnet-maestro-bot @dotnet-maestro
@halter73 @dougbu @pranavkm @TanayParikh
[automated] Merge branch 'release/5.0' => 'master' (#26767)
d0978cd 
* Update dependencies from https://github.com/dotnet/runtime build 20201009.6 (#26755)

[release/5.0] Update dependencies from dotnet/runtime

* Update dependencies from https://github.com/dotnet/efcore build 20201009.3 (#26764)

[release/5.0] Update dependencies from dotnet/efcore

* Add docs for Session, Diagnostics.EntityFrameworkCore, MiddlewareAnalysis and HeaderPropagation (#26720)

* Update dependencies from https://github.com/dotnet/runtime build 20201010.7 (#26792)

[release/5.0] Update dependencies from dotnet/runtime

* !!! Correct condition controlling `public` API analysis !!! (#26797)

* !!! Correct condition controlling `public` API analysis !!!
-  #26785 demonstrated analyzers were inoperable

* Remove unused `public` API files

* Update `public` API files
- three Components files were missing `#nullable enable`
- `nullable` annotations missing or out-of-date elsewhere

* Ignore `public` API files completely during source build
- do not warn about unused files

* Update more `public` API files

* Update dependencies from https://github.com/dotnet/efcore build 20201012.2 (#26816)

Microsoft.EntityFrameworkCore.Tools , dotnet-ef , Microsoft.EntityFrameworkCore , Microsoft.EntityFrameworkCore.Design , Microsoft.EntityFrameworkCore.InMemory , Microsoft.EntityFrameworkCore.Relational , Microsoft.EntityFrameworkCore.Sqlite , Microsoft.EntityFrameworkCore.SqlServer
 From Version 5.0.0-rtm.20509.3 -> To Version 5.0.0

Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com>

* Quarantine flaky test (#26627)

* Stabilize package Versions for 5.0.0 (#26650)

- remove `$(DisableServicingFeatures)` property; `$(IsServicingBuild)` works now

* Remove unneeded package sources

* Fix PublicAPI.Unshipped.txt files to match source

* Fix PublicAPI.Unshipped.txt files to match source II

* Add <inheritdoc />

Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Stephen Halter <[email protected]>
Co-authored-by: Doug Bunting <[email protected]>
Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Pranav K <[email protected]>
Co-authored-by: Tanay Parikh <[email protected]>
@amcasey amcasey added the area-middleware Includes: URL rewrite, redirect, response cache/compression, session, and other general middlewares label Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BrennanConroy BrennanConroy BrennanConroy approved these changes

@pranavkm pranavkm Awaiting requested review from pranavkm

@Tratcher Tratcher Awaiting requested review from Tratcher Tratcher is a code owner

@wtgodbe wtgodbe Awaiting requested review from wtgodbe

+1 more reviewer

@jkotalik jkotalik jkotalik approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area-middleware Includes: URL rewrite, redirect, response cache/compression, session, and other general middlewares tell-mode Indicates a PR which is being merged during tell-mode
Projects
None yet
Milestone
5.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@halter73 @BrennanConroy @jkotalik @amcasey