Skip to content

Commit ad6685b

Browse files
authored
Correct confusing headers in HLSLDocs (#100017)
AvailabilityDiagnostics.rst and ExpectedDifferences.rst both had multiple headers that were perceived to be the "top-level". In AvailabilityDiagnostics.rst two headers had both over and underlines. The second was the "Examples" section so it showed up in the top level HLSL docs. The overline is removed here so it's clear it's a subheader. In ExpectedDifferences.rst, the first header had no overline, so a few headers that looked the same were included. The overline is added to the top header to make clear that it's the main header.
1 parent 9147147 commit ad6685b

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

clang/docs/HLSL/AvailabilityDiagnostics.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ If the compilation target is a shader library, only availability based on shader
5252

5353
As a result, availability based on specific shader stage will only be diagnosed in code that is reachable from a shader entry point or library export function. It also means that function bodies might be scanned multiple time. When that happens, care should be taken not to produce duplicated diagnostics.
5454

55-
========
5655
Examples
5756
========
5857

@@ -62,7 +61,7 @@ For the example below, the ``WaveActiveCountBits`` API function became available
6261
The availability of ``ddx`` function depends on a shader stage. It is available for pixel shaders in shader model 2.1 and higher, for compute, mesh and amplification shaders in shader model 6.6 and higher. For any other shader stages it is not available.
6362

6463
Compute shader example
65-
======================
64+
----------------------
6665

6766
.. code-block:: c++
6867

@@ -94,7 +93,7 @@ With strict diagnostic mode, in addition to the 2 errors above Clang will also e
9493
<>:7:13: error: 'WaveActiveCountBits' is only available on Shader Model 6.5 or newer
9594
9695
Shader library example
97-
======================
96+
----------------------
9897

9998
.. code-block:: c++
10099

clang/docs/HLSL/ExpectedDifferences.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1+
===================================
22
Expected Differences vs DXC and FXC
33
===================================
44

0 commit comments

Comments
 (0)