Skip to content
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

Line numbers in error messages #132

Open
analog-cbarber opened this issue Feb 1, 2022 · 1 comment
Open

Line numbers in error messages #132

analog-cbarber opened this issue Feb 1, 2022 · 1 comment
Labels
feature New feature or request

Comments

@analog-cbarber
Copy link

I have seen errors like Failed to get 'name: description' pair from '', which even given the name of the docstring, can be hard to track down.

It would be really nice if every error message always included a line number.

It would be even better if all line numbers were reported as actual source lines using a format that
IDEs will recognize so that you make. For instance, pylint will prefix each error with a <filepath>:<line#>: .
It makes fixing errors MUCH easier for the user.

@analog-cbarber analog-cbarber added the feature New feature or request label Feb 1, 2022
@pawamoy
Copy link
Member

pawamoy commented Feb 1, 2022

Again, nice idea, thanks @analog-cbarber!

Griffe should already behave better regarding line numbers in warnings. But I guess we can leave this open as a simple improvement/bugfix for the time pytkdocs will continue to be used in projects, through the legacy handler.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants