Expand docs for margin and index generation. #212
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #212 +/- ##
=======================================
Coverage 99.74% 99.74%
=======================================
Files 24 24
Lines 1186 1186
=======================================
Hits 1183 1183
Misses 3 3 ☔ View full report in Codecov by Sentry. |
nevencaplar
approved these changes
Feb 12, 2024
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.
Change Description
Gives all the help I can think to give when generating margin caches or index tables.
Note that this duplicates A LOT of the text between
catalogs/arguments.rst,guide/margin_cache.rstandguide/index_table.rst. This is intentional, and based on feedback I got from Troy about duplicating some argument specifications instead of making users look in a few different places to put their pipeline together.