Skip to content

Update comment to better describe the serviceBroker param #364

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update comment to better describe the serviceBroker param #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.ServiceHub.Framework/ServiceHub/LazyAuthorizationServiceProxy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ internal class LazyAuthorizationServiceProxy : IAuthorizationService, IDisposabl
/// <summary>
/// Initializes a new instance of the <see cref="LazyAuthorizationServiceProxy"/> class.
/// </summary>
/// <param name="serviceBroker">A service broker used to acquire the activation service.</param>
/// <param name="serviceBroker">An optional service broker used to acquire the activation service.</param>
Copy link
Member

@AArnott AArnott Oct 17, 2025

Choose a reason for hiding this comment

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

This still doesn't document what behavior will be when the service broker is missing.
In fact the class already didn't document what would happen when the underlying auth service was missing. Maybe document them together at the class level under <remarks>.

Copy link
Member Author

@RyanToth3 RyanToth3 Oct 17, 2025

Choose a reason for hiding this comment

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

I'll write up something more thorough

/// <param name="joinableTaskFactory">An optional <see cref="JoinableTaskFactory"/> to use when scheduling async work, to avoid deadlocks in an application with a main thread.</param>
public LazyAuthorizationServiceProxy(IServiceBroker? serviceBroker, JoinableTaskFactory? joinableTaskFactory)
{
Expand Down
Loading