Improve PriorityQueue documentation #49392
Conversation
eiriktsarpalis
added
documentation
|
Tagging subscribers to this area: @eiriktsarpalis Issue DetailsContributes to #43957.
|
| /// <typeparam name="TElement">Specifies the type of elements in the queue.</typeparam> | ||
| /// <typeparam name="TPriority">Specifies the type of priority associated with enqueued elements.</typeparam> | ||
| /// <remarks> | ||
| /// Implements an array-backed quaternary min-heap. Each element is enqueued with an associated priority |
There was a problem hiding this comment.
The array-backed and quarternary parts of this are implementation detail. Do they need to be in here? Are we guaranteeing that will be the case forever more?
There was a problem hiding this comment.
Are we guaranteeing that will be the case forever more?
I'm thinking that this is more informational rather than a behaviour users would rely on. As such, we could always update the docs as we evolve the implementation without consequence.
| @@ -8,11 +8,14 @@ | |||
| namespace System.Collections.Generic | |||
| { | |||
| /// <summary> | |||
| /// Represents a data structure in which each element has an associated priority | |||
| /// that determines the order in which the pair is dequeued. | |||
| /// Represents a min priority queue. | |||
There was a problem hiding this comment.
Is this three space indent the intended formatting? We generally don't use that elsewhere to my knowledge.
There was a problem hiding this comment.
Not sure what the standard formatting is TBH. I expect that @carlossanlop's tool will eventually force a uniform style as we backport content from dotnet-api-docs.
| /// Constructs the heap using a heapify operation, | ||
| /// which is generally faster than enqueuing individual elements sequentially. |
There was a problem hiding this comment.
I'm assuming most users would want to know what differentiates this method over just calling Enqueue();Dequeue()
* upstream/main: (83 commits) Fix a crash in llvm if the sreg of a setret is not set because the methods ends with a throw. (dotnet#49122) [macOS-arm64] Disable failing libraries tests (dotnet#49400) improve PriorityQueue documentation (dotnet#49392) [wasm] Fix debugger tests (dotnet#49206) [mono] Fix the emission of EnumEqualityComparer instances into the corlib AOT image. (dotnet#49402) jitutils M2M renaming reaction (dotnet#49430) WinHttpHandler: Read HTTP/2 trailing headers [RyuJIT] Make casthelpers cold for sealed classes (dotnet#49295) JIT: Non-void ThrowHelpers (dotnet#48589) Update package index for servicing (dotnet#49417) Remove unnecessary check on polymorphic serialization (dotnet#48464) Remove release build cron triggers from jitstress jobs (dotnet#49333) [main] Update dependencies from dotnet/arcade dotnet/llvm-project dotnet/runtime-assets (dotnet#49359) Implement AppleCryptoNative_X509GetRawData using SecCertificateCopyData [AndroidCrypto] Support a zero-length salt for HMACs. (dotnet#49384) Use managed implementation of pbkdf2 for Android's one-shot implementation. (dotnet#49314) Make 303 redirects do GET like Net Framework (dotnet#49095) Make sure event generation is incremental (dotnet#48903) Add amd and Surface arm64 perf runs (dotnet#49389) Enregister EH var that are single def (dotnet#47307) ...
ghost
locked as resolved and limited conversation to collaborators
Contributes to #43957.