Doc: explain Napoleon configuration for import aliases - #14642
Open
jdillard wants to merge 1 commit into
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
1 participant
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.
Purpose
Explains how to translate import aliases used in docstring type definitions with
napoleon_preprocess_typesandnapoleon_type_aliases. This adds annp.ndarrayexample and clarifies that Napoleon cannot infer module imports from docstring text.The long-running discussion on #10151 attracted several affected users and proposed workarounds, indicating to me that the existing configuration was difficult to discover.
References
AI Disclosure
AI was used to investigate #10151 and draft the documentation improvement.