DOC Improve custom sort key docs#1401
Merged
lucyleeow merged 7 commits intosphinx-gallery:masterfrom Nov 8, 2024
Merged
Conversation
for more information, see https://pre-commit.ci
lucyleeow
commented
Nov 7, 2024
lucyleeow
commented
Nov 7, 2024
| } | ||
|
|
||
| Keep in mind that both lists have to be of the same length. | ||
| Keep in mind that both lists should be of the same length. |
Contributor
Author
There was a problem hiding this comment.
Technically, it can be of differing lengths, we'll just give a warning.
drammock
approved these changes
Nov 7, 2024
Member
drammock
left a comment
There was a problem hiding this comment.
left some minor-ish suggestions for improvement / clarification. But overall I think you've covered all the bases quite nicely, thanks!
doc/configuration.rst
Outdated
| to example files and :ref:`backreference files <minigalleries_to_examples>` | ||
|
|
||
| The best way to do this is to define a sort function, that takes the passed path | ||
| string:: |
Member
There was a problem hiding this comment.
Suggested change
| string:: | |
| string. For example, this function puts all filenames starting with ``plot_`` before | |
| all other filenames:: |
Contributor
Author
|
Thanks so much for your thorough review! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Follows after #1391
within_subsection_orderallows class input, which will be instantiated by SG_get_callables@drammock if you have time, would you take a look at this as it follows on from your PR, thank you