Add module organization suggestion doc #6509
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Suggest one method to keep slang modules organized in the file system. Closes shader-slang#4841
csyonghe
reviewed
Mar 3, 2025
|
|
||
| ### Module Organization Suggestions | ||
|
|
||
| - Top-level modules are those that are `import`ed by user code. |
There was a problem hiding this comment.
The terminology isn't very accurate: the util.slang is the "main module file", and files being __included are just files in that module. They are not "submodules".
Think about a module as a Visual Studio C++/C# Project, and a file is just a file in that project.
There was a problem hiding this comment.
Please let me know if I missed any inaccuracies.
cheneym2
force-pushed
the
cheneym2/moduledocs
branch
from
cc0cdd9 to
99f8e40
Compare
csyonghe
approved these changes
Mar 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Suggest one method to keep slang modules organized in the file system.
Closes #4841