Explain event waited for specified number of ms

[monty241]

Summary

Without access to reference sources, it is not intuitively clear what is waited for. Source documents that it is a wait on a semaphore for access to the collection (occupied nodes).

[opbld30]

Docs Build status updates of commit 958441c:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Collections.Concurrent/BlockingCollection`1.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 the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[eiriktsarpalis]

I would change the wording slightly, it is already given that any method in class guarantees thread-safe access.

Suggested change

	<param name="millisecondsTimeout">The number of milliseconds to wait for thread-safe access to the collection, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
	<param name="millisecondsTimeout">The number of milliseconds to wait for the collection to accept the item, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>

[antonfirsov]

CC @layomia

[eiriktsarpalis]

Hi @monty241, would you be able to take a look at the feedback? Thanks

cc @gewarren

[monty241]

Hi @monty241, would you be able to take a look at the feedback? Thanks

cc @gewarren

Alternative is also fine. It answers the question I've had.

[opbld34]

Docs Build status updates of commit 5e39573:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Collections.Concurrent/BlockingCollection`1.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 the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[opbld30]

Docs Build status updates of commit bc55393:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Collections.Concurrent/BlockingCollection`1.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 the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[opbld30]

Docs Build status updates of commit 48d844c:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Collections.Concurrent/BlockingCollection`1.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 the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[opbld33]

Docs Build status updates of commit 48d844c:

✅ Validation status: passed

File	Status	Preview URL	Details
xml/System.Collections.Concurrent/BlockingCollection`1.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 the docs.microsoft.com contributor guides
• Post your question in the Docs support channel