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

:check-doc location information for errors #1710

Open
weaversa opened this issue Jul 24, 2024 · 1 comment
Open

:check-doc location information for errors #1710

weaversa opened this issue Jul 24, 2024 · 1 comment
Assignees

Comments

@weaversa
Copy link
Collaborator

weaversa commented Jul 24, 2024

Notice the missing space:

/**
 * ```
 * :check True
 *```
 */

And when running :check-doc I got:

MyModule> :check-doc


Unclosed code block
Successes: 0, Failures: 1

This missing space was buried in a larger file and it took some time to figure out where to look. Would it be possible to provide location information for errors?

@yav yav added the docstrings label Aug 9, 2024
@glguy glguy self-assigned this Aug 13, 2024
@glguy
Copy link
Member

glguy commented Aug 13, 2024

I'd eventually like to thread filename:line information into docstrings but currently the situation has improved in two ways:

  1. The markdown parser considers this example a valid code fence (because GitHub markdown considers is valid)
  2. When errors are encountered the output reports the name of the definition being checked and the line of text that was invalid

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

No branches or pull requests

3 participants