Adopt JSDoc to document TypeScript code #11309
Replies: 2 comments
-
Given bokehjs is written in TypeScript, any tool of choice should be TypeScript specific, e.g. https://typedoc.org/. Last time I tried it, it had issues with our codebase, but hopefully it improved by now. |
Beta Was this translation helpful? Give feedback.
-
There are a couple of things to consider. Primarily, who is the audience for "API" docs? Setting aside Accordingly, I think doctrings for methods/functions in the library would be mostly for developers of Bokeh itself. I think that's fine but we should keep that in mind explicitly, both when prioritizing and deciding where and how to publish the docs, and what context to frame them in. So then: is there a place for primarily user-facing BokehJS docs? I think there is one existing, and one potential: The first is What also might be relevant in the future is if we decide to create APIs specifically to be useful in |
Beta Was this translation helpful? Give feedback.
-
It would be useful to add JSDoc to Bokeh's TypeScript code, having in mind that some code is unique to the TypeScript part of Bokeh and it's getting quite big and complex at the moment. Additionally, we can use tools like sphinx-js to increment our documentation.
cc: @tcmetzger @bryevdv @mattpap
Beta Was this translation helpful? Give feedback.
All reactions