Skip to content

Programmatic usage example needs updating #91

Closed
@stevegore

Description

@stevegore

Expected Behavior

Running the example should return documentation with no exceptions

Actual Behavior

Running the example with actual module names fails with: AttributeError: 'str' object has no attribute '__name__'

Steps to Reproduce

  1. Copy paste the example provided
  2. Replace 'a', 'b' with module names or a path to a module.
  3. Execute.

Attempting to use pdoc.import_module(mod) is not sufficient to make the example viable.

Additional info

  • pdoc version: 0.6.3

Metadata

Metadata

Assignees

No one assigned

    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