Skip to content

mkdocstrings/griffe-public-redundant-aliases

Repository files navigation

griffe-public-redundant-aliases

documentation gitpod gitter

Mark objects imported with redundant aliases as public.

Installation

This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.

Usage

Enable the griffe_public_redundant_aliases extension. Now all objects imported with redundant aliases will be marked as public, as per the convention.

# Following objects will be marked as public.
from somewhere import Thing as Thing
from somewhere import Other as Other

# Following object won't be marked as public.
from somewhere import Stuff

With MkDocs:

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_public_redundant_aliases