Skip to content

bug: unwrap_annotated not working #249

Description

@jayqi

Description of the bug

I am using unwrap_annotated: true but I still see Annotated in my signatures.

Image

Expected behavior

I expect the first two arguments in the signature to render as

    editor: Optional[str] = None,
    venue: Venue = Venue.GH,

Environment information

  • System: macOS-14.7.2-x86_64-i386-64bit
  • Python: cpython 3.12.7 (/Users/jqi/repos/reprexlite/.venv/bin/python)
  • Environment variables:
  • Installed packages:
    • mkdocs v1.6.1
    • mkdocstrings v0.28.1
    • mkdocstrings-python v1.15.0
    • griffe v1.5.7

Additional context

Here is my configuration (source):

  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [../reprexlite]
          options:
            # General
            docstring_style: google
            # Headings options
            heading_level: 2
            show_root_toc_entry: false
            show_root_full_path: false
            show_root_heading: false
            show_category_heading: true
            # Members options
            filters: ["!^_", "^__init__$"]
            # Docstrings options
            show_if_no_docstring: false
            merge_init_into_class: true
            # Signatures/annotation options
            annotations_path: brief
            separate_signature: true
            show_signature_annotations: true
            unwrap_annotated: true
            # Additional options
            show_source: true

Here is a link to my class definition: source

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions