-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Improve error messaging in sidebar YAML parser #15326
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
Comments
Could I work on this? |
Thank you for your interest, sure, feel free to do so! Do you already have a specific plan in mind? |
Thank you. Actually, I don't have plan not right now. But, I am interested in this and want to check detail. |
I don’t have anything in particular off the top of my head: I would try to write incorrect sidebar files, look at the output of scaladoc, and see how to improve it… |
Hello @gringrape, I was going to start correcting this issue but I see that you have started working on it. Is this still the case? Have you started anything? |
I have started a first PR with some questions, if you are interested to see it. |
https://github.com/lampepfl/dotty/blob/main/scaladoc/src/dotty/tools/scaladoc/site/SidebarParser.scala
contains only general info about the file format and returns a general error for all problems. The idea is to improve the error handling so that user can see an erroneous line or which information is missing.
The text was updated successfully, but these errors were encountered: