Skip to content
This repository was archived by the owner on Apr 8, 2020. It is now read-only.

Conversation

@pherbel
Copy link

@pherbel pherbel commented Feb 21, 2018

Fix for #1505

@pherbel
Copy link
Author

pherbel commented Mar 20, 2018

@SteveSandersonMS
Could you please review it and merge if it possible?
Could it be part of the next preview release?
Thanks

@SteveSandersonMS
Copy link
Member

This looks good - thanks for contributing it, @pherbel!

The only thing missing is updates to the XML docs. If a public method changes from void to non-void, then in its XML docs we also need to add a <returns>...</returns> entry to document what it now returns.

Example:

 /// <summary> /// Adds NodeServices support to the <paramref name="serviceCollection"/>. /// </summary> /// <param name="serviceCollection">The <see cref="IServiceCollection"/>.</param> /// <returns>A reference to this instance after the operation has completed.</returns> public static IServiceCollection AddNodeServices(this IServiceCollection serviceCollection) => AddNodeServices(serviceCollection, _ => {});

In every case it looks like you're returning the this value, so the description A reference to this instance after the operation has completed. would be OK for all of them.

Would you mind updating the XML docs in that way? Then I'd definitely be happy to merge it.

Add other missing builder extension method return value and xml docs.
@pherbel
Copy link
Author

pherbel commented Mar 26, 2018

Thanks @SteveSandersonMS

It absolutely makes sense. I missed it first time.
I fixed the missing xml docs and I also added return value and xml doc for other builder extension method what I forgot too. Now it will be consistent in all builder API.

Thanks your time!

@natemcmaster natemcmaster changed the base branch from dev to master July 2, 2018 17:58
@Eilon
Copy link
Contributor

Eilon commented Jan 2, 2019

Hi, this pull request is being closed because this repo is archived and all the source code and issues have been moved to the https://github.com/aspnet/AspNetCore repository. If you would like to send a new PR, you can find the new location for the source code here: https://github.com/aspnet/AspNetCore/tree/master/src/Middleware/NodeServices

Thanks,
Eilon

@Eilon Eilon closed this Jan 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

3 participants