Skip to content

Collect "from imports" as referencable names for docstrings #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lagru
Copy link
Member

@lagru lagru commented Jul 17, 2025

This makes it possible to use symbols made available via "from imports" within the same module. This lessens the need to declare types manually.

E.g.

from calendar import January as Jan, Day

def last_day(m):
    """
    Parameters
    ----------
    m : Jan

    Returns
    -------
    day : Day
    """

will work out of the box without having to declare Jan or Day in config. This also works for relative imports.

This feature is related to #20.

@lagru lagru added this to the v0.4 milestone Jul 17, 2025
@lagru lagru added the enhancement New feature or request label Jul 17, 2025
This makes it possible to use symbols made available via "from imports"
within the same module. This lessens the need to declare types manually.
@lagru lagru force-pushed the collect-from-imports branch from a45912e to 5875713 Compare July 17, 2025 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant