WIP: Log implicit refs #928
Open
Conversation
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
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.
@StefRe working on using the exclusion of implicit refs for MNE-Python, it occurred to me that it would be nice to have a way for SG to tell me what its most common implicit refs are. This PR adds support for this via:
For example, this is what
tinybuildnow gives:And for MNE-Python running a subset of our docs (after excluding a few):
WDYT @StefRe ?
One problem is that exclusion currently works when creating the set of possible references to resolve. We do this for example by adding both
mne.epochs.Epochsandmne.Epochsto the list of backreferences, then figuring out which is actually documented in the API docs later. My ugly workaround for now is just to keep count based on thenamerather than themodule.name. A better fix would be to delay the counting/printing until later, when we resolve which one is actually correct. Then we can give the name as it shows up in the API docs. So that's going in the TODO...Todo:
-D-incompatible gallery conf switchesAnother option would be to write these to a file at the end of the build like we do for
sg_execution_times.rst, which would also be easy. Not sure which is better.