Skip to content

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

Closed
pikinier20 opened this issue May 30, 2022 · 6 comments · Fixed by #17229
Closed

Improve error messaging in sidebar YAML parser #15326

pikinier20 opened this issue May 30, 2022 · 6 comments · Fixed by #17229
Labels
area:doctool good first issue Perfect for someone who wants to get started contributing itype:enhancement
Milestone

Comments

@pikinier20
Copy link
Contributor

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.

@pikinier20 pikinier20 added itype:enhancement area:doctool good first issue Perfect for someone who wants to get started contributing labels May 30, 2022
@gringrape
Copy link

Could I work on this?

@julienrf
Copy link
Contributor

julienrf commented Feb 3, 2023

Thank you for your interest, sure, feel free to do so! Do you already have a specific plan in mind?

@gringrape
Copy link

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.
Or could you share your idea?

@julienrf
Copy link
Contributor

julienrf commented Feb 3, 2023

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…

@Dedelweiss
Copy link
Contributor

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?

@Dedelweiss
Copy link
Contributor

I have started a first PR with some questions, if you are interested to see it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:doctool good first issue Perfect for someone who wants to get started contributing itype:enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants