Skip to content

style: precommit#1114

Merged
alandtse merged 1 commit into
community-shaders:devfrom
alandtse:workflow_lint
Jun 4, 2025
Merged

style: precommit#1114
alandtse merged 1 commit into
community-shaders:devfrom
alandtse:workflow_lint

Conversation

@alandtse
Copy link
Copy Markdown
Contributor

@alandtse alandtse commented Jun 3, 2025

Summary by CodeRabbit

  • Style
    • Improved consistency and readability across multiple files by removing trailing spaces, extra blank lines, and adjusting indentation in comments, license texts, and documentation.
    • Enhanced markdown formatting in the README for better clarity.
    • Standardized comment formatting throughout code and shader files.
  • Documentation
    • Cleaned up formatting in license files and documentation comments without altering any substantive content or legal terms.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2025

Walkthrough

This change consists exclusively of whitespace and formatting corrections across multiple files, including source code, shader files, markdown documentation, licenses, and workflow configurations. No functional, logical, or behavioral modifications have been made to any code, comments, or documentation content. All adjustments are purely cosmetic.

Changes

Files/Groups Change Summary
.github/workflows/build.yaml, Dockerfile, CMakeLists.txt Removed trailing spaces and blank lines for cleaner formatting.
README.md Reformatted bullet points and indentation for markdown consistency; no content changes.
features/Frame Generation/SKSE/Plugins/Streamline/nvngx_dlss.license.txt,
features/Skylighting/Shaders/Skylighting/SpatiotemporalBlueNoise/License.txt,
package/Interface/CommunityShaders/Fonts/OFL.txt
Whitespace and formatting cleanup in license texts; no changes to legal terms or content.
features/Subsurface Scattering/Shaders/SubsurfaceScattering/SeparableSSS.hlsli,
package/Shaders/Common/FastMath.hlsli,
package/Shaders/Common/VR.hlsli
Removed trailing spaces and adjusted comment formatting in shader files; no code changes.
include/dx12/ffx_api_dx12.h,
include/dx12/ffx_api_dx12.hpp,
include/ffx_api.h,
include/ffx_api.hpp,
include/ffx_api_loader.h,
include/ffx_api_types.h,
include/ffx_framegeneration.h,
include/ffx_framegeneration.hpp
Whitespace and comment formatting corrections in headers; no code or declaration changes.
src/Feature.h,
src/State.h,
src/ShaderCache.h,
src/Utils/Format.h,
src/Utils/Game.h,
src/Utils/GameSetting.h
Whitespace and comment formatting adjustments in source/header files; no logic or functional changes.

Possibly related PRs

Poem

A hop, a skip, a tidy sweep—
Whitespace gone, our files now neat!
No logic changed, no code to break,
Just cleaner lines for clarity’s sake.
With every space and trailing line,
The codebase shines—oh, how divine!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34fa791 and 4a6fd45.

⛔ Files ignored due to path filters (1)
  • features/Light Limit Fix/Shaders/LightLimitFix/ClusterCullingCS.hlsl is excluded by !**/*.hlsl
📒 Files selected for processing (24)
  • .github/workflows/build.yaml (1 hunks)
  • CMakeLists.txt (1 hunks)
  • Dockerfile (1 hunks)
  • README.md (3 hunks)
  • features/Frame Generation/SKSE/Plugins/Streamline/nvngx_dlss.license.txt (16 hunks)
  • features/Skylighting/Shaders/Skylighting/SpatiotemporalBlueNoise/License.txt (17 hunks)
  • features/Subsurface Scattering/Shaders/SubsurfaceScattering/SeparableSSS.hlsli (1 hunks)
  • include/dx12/ffx_api_dx12.h (4 hunks)
  • include/dx12/ffx_api_dx12.hpp (1 hunks)
  • include/ffx_api.h (1 hunks)
  • include/ffx_api.hpp (1 hunks)
  • include/ffx_api_loader.h (1 hunks)
  • include/ffx_api_types.h (2 hunks)
  • include/ffx_framegeneration.h (3 hunks)
  • include/ffx_framegeneration.hpp (1 hunks)
  • package/Interface/CommunityShaders/Fonts/OFL.txt (1 hunks)
  • package/Shaders/Common/FastMath.hlsli (2 hunks)
  • package/Shaders/Common/VR.hlsli (4 hunks)
  • src/Feature.h (1 hunks)
  • src/ShaderCache.h (4 hunks)
  • src/State.h (1 hunks)
  • src/Utils/Format.h (1 hunks)
  • src/Utils/Game.h (3 hunks)
  • src/Utils/GameSetting.h (5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

22-22: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


24-24: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


25-25: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


27-27: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


29-29: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


30-30: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


31-31: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


36-36: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


38-38: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

🪛 LanguageTool
README.md

[uncategorized] ~68-~68: You might be missing the article “the” here.
Context: ...O_PLUGIN_DEPLOYMENT - This option is default "OFF" - Make sure `"AUTO_PLUGIN_DEP...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~74-~74: You might be missing the article “the” here.
Context: ...### AIO_ZIP_TO_DIST - This option is default "ON" - Make sure `"AIO_ZIP_TO_DIST"...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~80-~80: You might be missing the article “the” here.
Context: ...d #### ZIP_TO_DIST - This option is default "ON" - Make sure "ZIP_TO_DIST" is...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ...ders in /dist - If having a file with name CORE in the root of the features fold...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~87-~87: You might be missing the article “the” here.
Context: ... #### TRACY_SUPPORT - This option is default "OFF" - This will enable tracy supp...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ...ble tracy support, might need to delete build folder when this option is changed Whe...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

features/Frame Generation/SKSE/Plugins/Streamline/nvngx_dlss.license.txt

[style] ~53-~53: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...to enforce the terms of your agreements with respect to the distributed portions of the SDK. 3...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[uncategorized] ~58-~58: A comma might be missing here.
Context: ... on your behalf. If you are an academic institution you may allow users enrolled or employe...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[style] ~98-~98: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fficers and directors, from and against any and all claims, damages, obligations, losses, l...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[style] ~101-~101: This phrase is redundant. Consider using “outside”.
Context: ...ut of or related to your use of the SDK outside of the scope of this license, or not in co...

(OUTSIDE_OF)


[style] ~273-~273: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SDK. You are required to notify NVIDIA prior to commercial release of an application (i...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[typographical] ~276-~276: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...K or NGX SDK. Please send notifications to: https://developer.nvidia.com/sw-notific...

(RP_COLON)

features/Skylighting/Shaders/Skylighting/SpatiotemporalBlueNoise/License.txt

[formatting] ~13-~13: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ...his License by including in or with the Work either (a) a copyright notice referenci...

(WITH_THAT_COMMA)


[style] ~125-~125: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...to enforce the terms of your agreements with respect to the distributed portions of the SDK. 3...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[uncategorized] ~130-~130: A comma might be missing here.
Context: ... on your behalf. If you are an academic institution you may allow users enrolled or employe...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[style] ~170-~170: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fficers and directors, from and against any and all claims, damages, obligations, losses, l...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[style] ~173-~173: This phrase is redundant. Consider using “outside”.
Context: ...ut of or related to your use of the SDK outside of the scope of this license, or not in co...

(OUTSIDE_OF)


[style] ~345-~345: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SDK. You are required to notify NVIDIA prior to commercial release of an application (i...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[typographical] ~348-~348: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...K or NGX SDK. Please send notifications to: https://developer.nvidia.com/sw-notific...

(RP_COLON)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build plugin and addons
🔇 Additional comments (28)
include/dx12/ffx_api_dx12.hpp (1)

4-4: Whitespace cleanup: Removed a trailing space from the copyright comment, improving formatting consistency.

src/State.h (1)

95-95: Whitespace cleanup: Removed trailing whitespace in the comment block for IsDeveloperMode(), aligning with the PR’s formatting cleanup.

include/ffx_framegeneration.hpp (1)

4-4: Whitespace cleanup: Removed trailing space in the copyright header comment, consistent with other header files.

include/ffx_api_loader.h (1)

4-4: Whitespace cleanup: Removed trailing space in the header comment, matching the overall formatting improvements.

include/ffx_api.hpp (1)

4-4: Whitespace cleanup: Removed trailing space in the header comment to maintain uniform formatting across files.

include/ffx_api.h (1)

4-4: Whitespace-only revision: Removed a trailing space from the empty comment line to maintain consistent formatting. No functional impact.

CMakeLists.txt (1)

219-219: Trailing blank line removal: Removed an extra blank line after the add_custom_target(COPY_SHADERS ALL ...) block. Purely cosmetic.

package/Interface/CommunityShaders/Fonts/OFL.txt (1)

20-20: Whitespace-only correction: Eliminated a trailing space at the end of the line in the license text. No change to legal content.

Dockerfile (2)

22-22: Whitespace cleanup: Removed trailing space from blank line after the Visual Studio Build Tools installation command.


26-26: Whitespace cleanup: Removed trailing space after the vcpkg bootstrap command.

src/Feature.h (1)

18-18: Formatting adjustment: Removed trailing whitespace in the comment for SupportsVR(). No change to logic or API.

features/Subsurface Scattering/Shaders/SubsurfaceScattering/SeparableSSS.hlsli (1)

8-8: LGTM! Clean formatting improvements in license header.

The trailing space removals improve formatting consistency within the license header comments without affecting any functional code.

Also applies to: 13-13, 19-31

package/Shaders/Common/FastMath.hlsli (1)

7-7: LGTM! Minor whitespace cleanup in documentation header.

The trailing space removals in the release notes and contact information improve formatting consistency without affecting the shader math library functionality.

Also applies to: 19-19

.github/workflows/build.yaml (1)

125-125: LGTM! Minor whitespace cleanup in jq filter.

The trailing space removal after .commits[] improves formatting consistency without affecting the functionality of the commit-based release notes generation.

include/ffx_api_types.h (1)

4-4: LGTM! Whitespace cleanup in comments and documentation.

The trailing space removals in the license header and frame pacing algorithm documentation improve formatting consistency without affecting any API definitions or functionality.

Also applies to: 198-198, 206-206, 208-208

src/Utils/Game.h (1)

8-8: LGTM! Excellent whitespace cleanup.

The trailing whitespace removal in comment blocks improves code consistency and follows best practices for maintaining clean codebases.

Also applies to: 10-10, 21-21, 23-23, 55-55

features/Frame Generation/SKSE/Plugins/Streamline/nvngx_dlss.license.txt (1)

14-14: LGTM! Appropriate whitespace cleanup for license file.

The trailing whitespace removal improves file consistency without altering the legal content of the license text.

Also applies to: 23-23, 39-39, 43-43, 49-49, 54-54, 61-61, 66-66, 79-79, 94-94, 102-102, 127-127, 129-129, 140-140, 158-158, 172-172, 184-184, 194-194, 201-201, 220-220, 257-257, 271-271, 279-279, 289-289, 312-312, 314-314

include/ffx_framegeneration.h (1)

4-4: LGTM! Clean whitespace formatting improvements.

The trailing whitespace removal in the copyright header and struct member comments enhances code consistency without affecting functionality.

Also applies to: 137-137, 165-165

src/Utils/Format.h (1)

13-13: LGTM! Improved documentation formatting.

The trailing whitespace removal in the Doxygen comment block enhances documentation consistency and readability.

Also applies to: 15-15, 17-17, 19-19

features/Skylighting/Shaders/Skylighting/SpatiotemporalBlueNoise/License.txt (1)

1-481: Whitespace-only formatting cleanup in license file
All edits in this file are purely cosmetic—trailing spaces were trimmed and line breaks were standardized. No changes to the actual license text or legal clauses.

🧰 Tools
🪛 LanguageTool

[formatting] ~13-~13: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ...his License by including in or with the Work either (a) a copyright notice referenci...

(WITH_THAT_COMMA)


[uncategorized] ~79-~79: You might be missing the article “the” here.
Context: ...nse can be accepted only by an adult of legal age of majority in the country in which...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[style] ~125-~125: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...to enforce the terms of your agreements with respect to the distributed portions of the SDK. 3...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[uncategorized] ~130-~130: A comma might be missing here.
Context: ... on your behalf. If you are an academic institution you may allow users enrolled or employe...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~154-~154: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... would cause it to become subject to an open source software license. As examples, licenses...

(EN_COMPOUND_ADJECTIVE_INTERNAL)


[uncategorized] ~163-~163: A punctuation mark might be missing here.
Context: ...ry, medical, life support or other life critical applications. NVIDIA does not design, t...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[style] ~170-~170: ‘any and all’ might be wordy. Consider a shorter alternative.
Context: ...fficers and directors, from and against any and all claims, damages, obligations, losses, l...

(EN_WORDINESS_PREMIUM_ANY_AND_ALL)


[style] ~173-~173: This phrase is redundant. Consider using “outside”.
Context: ...ut of or related to your use of the SDK outside of the scope of this license, or not in co...

(OUTSIDE_OF)


[uncategorized] ~196-~196: Possible missing comma found.
Context: ...mponents with separate legal notices or terms as may be described in proprietary noti...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~211-~211: Possible missing comma found.
Context: ...the sample source code delivered in the SDK including their respective intellectual...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~221-~221: ‘on account of’ might be wordy. Consider a shorter alternative.
Context: ...t obligation or restriction of any kind on account of intellectual property rights or otherwi...

(EN_WORDINESS_PREMIUM_ON_ACCOUNT_OF)


[uncategorized] ~225-~225: Possible missing comma found.
Context: ... MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW NVIDIA AND ITS AFFILIATES EXPRESSLY DIS...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~249-~249: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ... in any legal proceeding against NVIDIA with respect to the SDK. NVIDIA may terminate this lice...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[uncategorized] ~263-~263: Possible missing comma found.
Context: ... courts residing in Santa Clara County, California shall have exclusive jurisdiction over ...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~301-~301: This phrase is redundant. Consider using “subject” to avoid wordiness.
Context: ...ent between the parties relating to the subject matter of this license and supersedes all prio...

(SUBJECT_MATTER)


[style] ~303-~303: This phrase is redundant. Consider using “subject” to avoid wordiness.
Context: ...andings and agreements relating to this subject matter, whether oral or written. If any court ...

(SUBJECT_MATTER)


[style] ~339-~339: This phrase is redundant. Consider using “outside”.
Context: ... of such SDKs or their functionality is outside of the scope of the Agreement. For the pur...

(OUTSIDE_OF)


[misspelling] ~342-~342: This word is normally spelled with a hyphen.
Context: ...irtual system environments, or hosting, time sharing or providing any other type of service ...

(EN_COMPOUNDS_TIME_SHARING)


[style] ~345-~345: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... SDK. You are required to notify NVIDIA prior to commercial release of an application (i...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[typographical] ~348-~348: Do not use a colon (:) before a series that is introduced by a preposition (‘to’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...K or NGX SDK. Please send notifications to: https://developer.nvidia.com/sw-notific...

(RP_COLON)


[style] ~360-~360: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...nt any necessary patent or other rights with respect to any audio and/or video encoders and dec...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[uncategorized] ~363-~363: Possible missing comma found.
Context: ... Terms. By installing or using the DLSS SDK you agree that NVIDIA can make over-the...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~368-~368: Try moving the adverb to make the sentence clearer.
Context: ...impacting the user experience, you will work to quickly address the integration issues. In the case issues are not addressed, ...

(SPLIT_INFINITIVE)


[style] ~371-~371: Consider using a different verb for a more formal wording.
Context: ...LSS integration until the issues can be fixed. 6. Marketing. 6.1 Marketing Activiti...

(FIX_RESOLVE)


[grammar] ~389-~389: You used an adverb (‘about’) instead of an adjective, or a noun (‘box’) instead of another adjective.
Context: ... NVIDIA Marks on splash screens, in the about box of the application (if present), and in...

(A_RB_NN)


[grammar] ~393-~393: Possible subject-verb agreement error detected.
Context: ...S SDK or NGX SDK. For applications that incorporates and/or makes use of a licensed SDK, oth...

(PLURAL_THAT_AGREEMENT)


[uncategorized] ~401-~401: Possible missing comma found.
Context: ...s which incorporate the DLSS SDK or NGX SDK as applicable. To the extent that you p...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~402-~402: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ...ide NVIDIA with input or usage requests with regard to the use of your logo or materials, NVID...

(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)


[style] ~406-~406: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...iration or termination of the Agreement with respect to existing applications which incorporate...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[misspelling] ~414-~414: This word is normally spelled as one.
Context: ...pplication to the public to distribute, sub-license, and use the Assets to promote and mark...

(EN_COMPOUNDS_SUB_LICENSE)


[style] ~416-~416: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ...ide NVIDIA with input or usage requests with regard to the use of your logo or materials, NVID...

(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)


[style] ~419-~419: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...urvive any termination of the Agreement with respect to applications which incorporate the NVID...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[style] ~456-~456: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...s Marks at least ten (10) business days prior to the desired implementation of such use ...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[uncategorized] ~460-~460: You might be missing the article “the” here.
Context: ... approval. All goodwill associated with use of NVIDIA Marks will inure to the sole ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[style] ~466-~466: ‘with respect to’ might be wordy. Consider a shorter alternative.
Context: ...ant that you will: (a) conduct business with respect to NVIDIA's products in a manner that refl...

(EN_WORDINESS_PREMIUM_WITH_RESPECT_TO)


[style] ~470-~470: ‘with regard to’ might be wordy. Consider a shorter alternative.
Context: ... no false or misleading representations with regard to NVIDIA or its products; and (d) not pub...

(EN_WORDINESS_PREMIUM_WITH_REGARD_TO)

src/Utils/GameSetting.h (1)

1-126: Comment formatting consistency maintained
The adjustments remove trailing spaces and normalize blank lines in Doxygen comments only. No functional code or declarations were altered.

README.md (1)

1-145: Markdown indentation and spacing standardized
All list items and sections were reformatted for consistent indentation and spacing. There are no content or instruction changes.

🧰 Tools
🪛 LanguageTool

[style] ~1-~1: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 5158 characters long)
Context: Latest Release License Last Commit Ask DeepWiki Build Status Pre-commit CI Discord Open Issues [![Contributors](https://img.shields.io/gi...

(EN_EXCESSIVE_EXCLAMATION)


[uncategorized] ~54-~54: You might be missing the article “a” here.
Context: ...at" amd64 ``` ## Clone and Build Open terminal (e.g., PowerShell) and run the followin...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[uncategorized] ~64-~64: A comma might be missing here.
Context: ...an example CMakeUserPreset to start off with you can copy the `CMakeUserPresets.json...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


[uncategorized] ~68-~68: You might be missing the article “the” here.
Context: ...O_PLUGIN_DEPLOYMENT - This option is default "OFF" - Make sure `"AUTO_PLUGIN_DEP...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~74-~74: You might be missing the article “the” here.
Context: ...### AIO_ZIP_TO_DIST - This option is default "ON" - Make sure `"AIO_ZIP_TO_DIST"...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~80-~80: You might be missing the article “the” here.
Context: ...d #### ZIP_TO_DIST - This option is default "ON" - Make sure "ZIP_TO_DIST" is...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~83-~83: You might be missing the article “the” here.
Context: ...ders in /dist - If having a file with name CORE in the root of the features fold...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~87-~87: You might be missing the article “the” here.
Context: ... #### TRACY_SUPPORT - This option is default "OFF" - This will enable tracy supp...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ...ble tracy support, might need to delete build folder when this option is changed Whe...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[misspelling] ~90-~90: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...eset you can call BuildRelease.bat with an parameter to specify which preset to co...

(EN_A_VS_AN)


[uncategorized] ~93-~93: Possible missing comma found.
Context: ...MENT` When switching between different presets you might need to remove the build fold...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~97-~97: Consider changing the order of words to improve your wording.
Context: ...Build with Docker For those who prefer to not install Visual Studio or other build de...

(TO_NOT_VB)


[uncategorized] ~99-~99: Possible missing comma found.
Context: ...ww.docker.com/products/docker-desktop/) first if not already there. 2. In a shell of ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~100-~100: Possible missing comma found.
Context: ...ot already there. 2. In a shell of your choice run to switch to Windows containers and...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~114-~114: A comma might be missing here.
Context: ...he build/aio folder. 5. In subsequent builds only run the build step (3.) #### Trou...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🪛 markdownlint-cli2 (0.17.2)

22-22: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


24-24: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


25-25: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


27-27: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


29-29: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


30-30: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


31-31: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


36-36: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


38-38: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


56-56: Fenced code blocks should have a language specified
null

(MD040, fenced-code-language)

package/Shaders/Common/VR.hlsli (1)

1-423: Shader comment whitespace cleanup
Removed trailing spaces from comment lines and aligned formatting within the Stereo namespace. No logic or API surface changes.

include/dx12/ffx_api_dx12.h (1)

1-319: Header whitespace and formatting cleanup
Adjusted blank lines and trimmed trailing spaces in comments and around declarations. Functional logic and API signatures remain untouched.

src/ShaderCache.h (4)

337-347: Improved comment block alignment for UpdateShaderModifiedTime
Reformatted the Javadoc-style block to remove trailing spaces and align asterisks uniformly.


349-359: Consistent formatting in ShaderModifiedSince documentation
Standardized multi-line comment spacing and asterisk alignment without altering any behavior.


363-382: Cleaned up Clear(a_path) comment block
Aligned the description, parameter, and note sections for improved readability and style consistency.


689-705: Unified comment formatting in UpdateListener::UpdateCache documentation
Adjusted spacing and asterisk placement for a clearer and more consistent doc comment.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 3, 2025

✅ A pre-release build is available for this PR:
Download

@alandtse alandtse merged commit 4edaccc into community-shaders:dev Jun 4, 2025
9 checks passed
alandtse added a commit to alandtse/open-shaders that referenced this pull request Jul 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants