Correct confusing headers in HLSLDocs #100017
Conversation
Because AvailabilityDiagnostics.rst mistakenly overlined the "Examples" section, it was included in the generated HLSLDocs page. By demoting it to a subheader, it shouldn't show up as a top-level HLSLDocs page.
pow2clk
added
clang
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write If you have received no comments on your PR for a week, you can request a review If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@llvm/pr-subscribers-hlsl @llvm/pr-subscribers-clang Author: Greg Roth (pow2clk) ChangesBecause AvailabilityDiagnostics.rst mistakenly overlined the "Examples" section, it was included in the generated HLSLDocs page. By demoting it to a subheader, it shouldn't show up as a top-level HLSLDocs page. Full diff: https://github.com/llvm/llvm-project/pull/100017.diff 1 Files Affected:
diff --git a/clang/docs/HLSL/AvailabilityDiagnostics.rst b/clang/docs/HLSL/AvailabilityDiagnostics.rst
index bb9d02f21dde6..7ce82c1946b87 100644
--- a/clang/docs/HLSL/AvailabilityDiagnostics.rst
+++ b/clang/docs/HLSL/AvailabilityDiagnostics.rst
@@ -52,7 +52,6 @@ If the compilation target is a shader library, only availability based on shader
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.
-========
Examples
========
|
|
See https://clang.llvm.org/docs/HLSL/HLSLDocs.html to see the effect |
ExpectedDifference sections were bleeding into the top page too
pow2clk
changed the title
Justin pointed out that the earlier change moved the examples out from the examples section. By demoting them as well, they will stay put
|
@pow2clk Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested Please check whether problems have been caused by your change specifically, as How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
|
Thanks @pow2clk ! |
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.
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.