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

User-friendly error messages #1168

Open
1 task
seeM opened this issue Oct 19, 2022 · 1 comment
Open
1 task

User-friendly error messages #1168

seeM opened this issue Oct 19, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@seeM
Copy link
Member

seeM commented Oct 19, 2022

We don't often catch exceptions and reraise errors with more specific and friendly messages. My personal preference is for verbose error messages written in a conversational tone with as much useful info for debugging as possible.

I'd like to use this issue to track specific cases of unhelpful error messages, which can each be tracked in their own issue:

@seeM seeM added the enhancement New feature or request label Oct 19, 2022
@VehpuS
Copy link

VehpuS commented Jan 24, 2023

I'm glad this issue exists. What came to mind right now, after another quick session of trying to parse error messages, is that a few generic validators that can run on some of the nbdev commands could be really useful, i.e.:

  1. settings.ini validator - is it well formated (i.e. before running nbdev_export, nbdev_clean)
  2. a notebook validator - is it a valid JSON? is each cell valid (i.e. catch python cells with indented blocks that are empty.

I imagine more things can be addressed this way (i.e. maybe a utility to test image tag in markdown cells before running docs?).

If that approach seems amenable, I wouldn't mind looking into 1 in the near term, if no one else is planning to do so. I can try to tackle 2 as well afterwards but I don't have much experience parsing ipynb files so someone else may be at an advantage :P

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

No branches or pull requests

2 participants