Automatic port of Microsoft.Extensions.ObjectPool docs

[carlossanlop]

Area owners of Microsoft.Extensions.ObjectPool: @maryamariyan @ericstj
Note: The area owners document does not have the label area-Extensions-ObjectPool.

[ericstj]

Title looks wrong. The problem pointed out is in PollyServiceCollectionExtensions. This appears to be a problem with the docs process as this type is extending a 3rd-party library and references it is complaining about are the types in that 3rd party component.

[ericstj]

@carlossanlop I think @BillWagner tried to fix this here #4218 but that isn't working completely. Can someone more familiar with this tool try to fix this one?

[ericstj]

Apologies, I misunderstood the purpose here. The validation warnings are due to the problem I mentioned above, which I do think @BillWagner should try to fix.

This is updating docs for Microsoft.Extensions.ObjectPool, which is part of ASP.NET -- @pranavkm @ryanbrandenburg

[BillWagner]

Thanks @ericstj

Adding @gewarren and @joelmartinez for the Polly based warnings. The XML files shouldn't have xrefs to the Polly docs. If so, we'll need to somehow get those removed because we don't publish the docs for those.

Pending that answer, this is ready to

[joelmartinez]

You could always put those polly XREFs in the missingapi.yml file, and point them to the correct external documentation page:
https://github.com/dotnet/dotnet-api-docs/blob/master/_zip/missingapi.yml

To be clear, this is a technical answer to the issue ... not sure how this is to be treated from an editorial perspective :)

[pranavkm]

I realize this is what the existing comment says, but should this say:

Suggested change

	<see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible/desirable for the pool to keep the object.</returns>
	<see langword="true" /> if the object should be returned to the pool. <see langword="false" /> if it's not possible or desirable for the pool to keep the object.</returns>

Similarly elsewhere

[carlossanlop]

Thank you @pranavkm for providing a suggestion. It's ok to change the original texts from triple slash, since the purpose of the dotnet-api-docs PRs is to get them through language review, like you did here 😄 . I'll apply your suggestion in all the places where I find similar text.

[opbld30]

Docs Build status updates of commit d0ef037:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/Microsoft.Extensions.ObjectPool/DefaultPooledObjectPolicy`1.xml	✅Succeeded	View
xml/Microsoft.Extensions.ObjectPool/PooledObjectPolicy`1.xml	✅Succeeded	View
xml/Microsoft.Extensions.ObjectPool/StringBuilderPooledObjectPolicy.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

• Try searching in the Docs contributor and Admin Guide
• See the frequently asked questions
• Post your question in the Docs support channel

[carlossanlop]

@BillWagner @gewarren can I get an approving sign-off please?

[BillWagner]

This LGTM @carlossanlop @ericstj

You can when ready.

[BillWagner]

I opened #4952 which should fix the Polly related build warnings. Working with @joelmartinez to make sure that's setup correctly.

[opbld34]

Docs Build status updates of commit 8e34b7f:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/Microsoft.Extensions.ObjectPool/DefaultPooledObjectPolicy`1.xml	✅Succeeded	View
xml/Microsoft.Extensions.ObjectPool/PooledObjectPolicy`1.xml	✅Succeeded	View
xml/Microsoft.Extensions.ObjectPool/StringBuilderPooledObjectPolicy.xml	✅Succeeded	View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

• Try searching in the Docs contributor and Admin Guide
• See the frequently asked questions
• Post your question in the Docs support channel