Skip to content

change: Make failed cross-reference lookup in docstrings clearer #54

Closed
@pushfoo

Description

@pushfoo

Is your change request related to a problem? Please describe.

When I had a typo in a docstring, the output reported the error as in the markdown file rather than the docstring:

WARNING -  mkdocs_autorefs: api/annotations.md: Could not find cross-reference target
           '[package.oop.annotations]'

Describe the solution you'd like

More detailed / accurate error output which includes:

  1. The docstring file
  2. The item the docstring is on
  3. Docstring line number
  4. Ideally, accurate file line number

Describe alternatives you've considered

N/A?

Additional context

I have:

  1. A package.annotations submodule
  2. A docs/api/annotations file using mkdautodocs (# ::: package.annotations)

The typo was in the package/annotations.py file

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions