Doc fix and clarification for n_slots in custom layout file #4641
+5
−3
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.
What I did
I updated the docs to fix the layout file example under
Scoping and Declarations
and clarify whyn_slots
is needed.How I did it
I added a couple lines of text under the example and inserted the necessary n_slot information for the layout to work in the example.
How to verify it
Compile the example locally to ensure its correctness
Commit message
Doc fix and clarification for n_slots in custom layout file
Commit message for the final, squashed PR. (Optional, but reviewers will appreciate it! Please see our commit message style guide for what we would ideally like to see in a commit message.)
Description for the changelog
Documentation update to fix the layout file example under
Scoping and Declarations
and clarify whyn_slots
is needed.Cute Animal Picture