Microsoft.Toolkit.HighPerformance docs page(s) #301
Conversation
|
Docs Build status updates of commit e4446f4: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 5d7538a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 4e759c1: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 3e7e5ed: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
There was a problem hiding this comment.
@Sergio0694 I'm wondering if this wants its own 'High Performance' section and that can be prefaced with the notion of what the package is about and why/when to use it in general (like what types of scenarios)?
Then we can have this page and maybe another one or two for broad strokes of the types of data structures, extensions, and helpers are in here?
Thoughts?
This also sets things up nicely if @Avid29 wants to contribute their extra collections?
|
@michael-hawker Yeah that's a good idea! I'll restructure this as you suggested and create a new I think it'd be a good idea to give a couple examples of the |
|
Docs Build status updates of commit 9ec4947: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit d7ffa6f: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 74ccfba: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit b4bae08: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit ec15797: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 96d2342: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit c1df57c: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit cbb6954: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
.openpublishing.publish.config.json
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
@michael-hawker Alright, following your advice I restructured the docs for the package into a new Let me know if this is better and if there's anything else I can do to improve things! 😄 |
|
Docs Build status updates of commit c8e6e87: 🕙 Full build: the average full build time is 5 min(s) 36 sec(s), this is based on the last 13 build(s) for this repository. |
|
Docs Build status updates of commit 4d7114f: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit ea6727b: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 1bb7d26: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Should definitely have an enumerables page, lots of cool stuff there :) |
|
Docs Build status updates of commit 1a57734: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit e0b7c06: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 8a0d6b8: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
docs/toc.md
Outdated
| # High performance | ||
| ## [Introduction](high-performance/Introduction.md) | ||
| ## Buffers | ||
| ### [MemoryOwner<T>](high-performance/MemoryOwner.md) |
There was a problem hiding this comment.
Don't think you convert here and use the < directly:
There was a problem hiding this comment.
Ah, you're right - I was doing this because using <T> wasn't working in the markdown preview, but I forgot this file isn't actually displayed as markdown at all in the docs 😄
Fixed in 4d21229.
|
Docs Build status updates of commit 4d21229: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit aafd2ed:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/high-performance/Introduction.md | View | Details | |
| docs/high-performance/MemoryOwner.md | ✅Succeeded | View | |
| docs/high-performance/ParallelHelper.md | ✅Succeeded | View | |
| docs/high-performance/Ref.md | ✅Succeeded | View | |
| docs/high-performance/SpanOwner.md | ✅Succeeded | View | |
| docs/toc.md | ✅Succeeded | View |
docs/high-performance/Introduction.md
- Line 56: [Warning]
Invalid file link:(~/high-performance/high-performance/SpanOwner.md). - Line 56: [Warning]
Invalid file link:(~/high-performance/high-performance/MemoryOwner.md). - Line 57: [Warning]
Invalid file link:(~/high-performance/high-performance/ParallelHelper.md).
For more details, please refer to the build report.
Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.
|
Docs Build status updates of commit 7418fd5: ✅ Validation status: passed
For more details, please refer to the build report. Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report. |
|
Docs Build status updates of commit 34abbeb: ✅ Validation status: passed
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:
|
This PR adds docs page(s) for APIs from the
Microsoft.Toolkit.HighPerformancepackage (#3128).So far I've only included docs for the
ParallelHelperclass, as all the other APIs are either just extension methods or have quite a lot of XML docs right over each method, so they're pretty self explanatory.