Scaladoc play button questions #15966
Replies: 3 comments 3 replies
-
|
In Dotty sources I found an undocumented (?) option Is that right? |
Beta Was this translation helpful? Give feedback.
-
|
there, it says:
as for Anton's question:
are you sure? it looks to me like |
Beta Was this translation helpful? Give feedback.
-
|
I think the person who is currently in charge of Scaladoc at VirtusLab is now @szymon-rd (but AFAIK he can’t have a deep look right now) |
Beta Was this translation helpful? Give feedback.
-
|
All of these issues will be addressed in the future. But that's true, it's an iterative process and we will allocate resources to next tasks related to scaladoc when we finish the current rework & fixes. |
Beta Was this translation helpful? Give feedback.
-
|
I can't find anything online where |
Beta Was this translation helpful? Give feedback.
-
|
Same, I created #16220. |
Beta Was this translation helpful? Give feedback.
-
Having the play button in your docs is seemingly super useful. I see that it's being used on some of the projects that have public docs. You can see a couple examples here:
However, as expected pretty much all library documentation is going to want to import code from their codebase as examples. Currently, when you click play the payload to Scastie doesn't contain anything in the
librariessection meaning it won't know anything about your library. So you assume you can run the documentation but you just get:What's the desired flow here? I imagine almost all libraries that will be using scaladocs as their doc site will have this sort of thing, will want to check that the snippet compiles (which it seems to when you create the docs), but then the play button will fail. I also then don't see a way to turn the play button off, unless you turn the compile checking off.
Is this just not something implemented? Are there plans for situations like this to work? Am I using/understanding this wrong?
Beta Was this translation helpful? Give feedback.
All reactions