Add <description> for items in a list

This commit is contained in:
Andrew Hall 2024-04-04 14:24:58 -07:00
Родитель d72cde3efa
Коммит d4c622cc36
2 изменённых файлов: 10 добавлений и 10 удалений

Просмотреть файл

@ -18,10 +18,10 @@
run at. Providers are run in priority order, allowing the results of higher priority providers to be computed
and shown to the user without having to wait on, or share computing resources with, lower priority providers.
Providers should choose lower priority classes if they are either:
<list type="number"><item>Very slow. Slow providers will impede computing results for other providers in the same priority class.
So running in a lower one means that fast providers can still get their results to users quickly.</item><item>Less relevant. Providers that commonly show available options, but those options are less likely to be
<list type="number"><item><description>Very slow. Slow providers will impede computing results for other providers in the same priority class.
So running in a lower one means that fast providers can still get their results to users quickly.</description></item><item><description>Less relevant. Providers that commonly show available options, but those options are less likely to be
taken, should run in lower priority groups. This helps ensure their items are still there when the user wants
them, but aren't as prominently shown.</item></list></summary>
them, but aren't as prominently shown.</description></item></list></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>

Просмотреть файл

@ -41,25 +41,25 @@
particular tree <em>in order</em>. Changes are given a <see cref="T:Microsoft.CodeAnalysis.SyntaxNode" /> they will apply to in the
original tree the editor is created for. The semantics of application are as follows:
<list type="number"><item>
<list type="number"><item><description>
The original root provided is used as the 'current' root for all operations. This 'current' root will
continually be updated, becoming the new 'current' root. The original root is never changed.
</item><item>
</description></item><item><description>
Each change has its given <see cref="T:Microsoft.CodeAnalysis.SyntaxNode" /> tracked, using a <see cref="T:Microsoft.CodeAnalysis.SyntaxAnnotation" />, producing a
'current' root that tracks all of them. This allows that same node to be found after prior changes are applied
which mutate the tree.
</item><item>
</description></item><item><description>
Each change is then applied in order it was added to the editor.
</item><item>
</description></item><item><description>
A change first attempts to find its <see cref="T:Microsoft.CodeAnalysis.SyntaxNode" /> in the 'current' root. If that node cannot be
found, the operation will fail with an <see cref="T:System.ArgumentException" />.
</item><item>
</description></item><item><description>
The particular change will run on that node, removing, replacing, or inserting around it according to the
change. If the change is passed a delegate as its 'compute' argument, it will be given the <see cref="T:Microsoft.CodeAnalysis.SyntaxNode" /> found in the current root. The 'current' root will then be updated by replacing the current
node with the new computed node.
</item><item>
</description></item><item><description>
The 'current' root is then returned.
</item></list></summary>
</description></item></list></summary>
<remarks>
The above editing strategy makes it an error for a client of the editor to add a change that updates a parent
node and then adds a change that updates a child node (unless the parent change is certain to contain the