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
ARROW-951: [JS] Upgrade to typedoc 0.20.19 #9375
Conversation
Thanks for opening a pull request! Could you open an issue for this pull request on JIRA? Then could you also rename pull request title in the following format?
See also: |
One issue with this change - it will break existing links. For example the docs for We could fix this by only generating using one entryPoint - either Arrow.dom.ts or Arrow.node.ts (or Arrow.ts), not both. |
@TheNeuralBit I think we have |
Merging; please feel free to make followup JIRAs. Plenty of time to polish the docs before the next release. |
Also ran `npm audit fix` This PR upgrades us beyond [typedoc 0.20](https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0) which made significant improvements to how re-exported objects are handled. I've uploaded a preview of the generated docs at https://theneuralbit.github.io/arrow-typedoc-0.20/. Compare this to the existing API docs at http://arrow.apache.org/docs/js/index.html. It properly reflects our two top-level modules, Arrow.dom and Arrow.node, and shows the objects exported within them. The existing docs give the impression of a bag of objects without any structure. There's still a lot of work to do to make these API docs useful, but I think this is a big step in the right direction (many thanks to @Gerrit0 for all the typedoc improvements that made this possible) . Some remaining issues that we could file follow-up jiras for: - Some objects are missing (e.g. Vector sub-classes like DateVector, FloatVector, ..). These also seem to be missing from the existing docs. It's possible this is a bug in typedoc? Will need further investigation. - Many classes and methods are still completely undocumented, so API docs tell users little aside from the structure of the code. Closes apache#9375 from TheNeuralBit/typedoc-0.20 Authored-by: Brian Hulette <hulettbh@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
Also ran `npm audit fix` This PR upgrades us beyond [typedoc 0.20](https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0) which made significant improvements to how re-exported objects are handled. I've uploaded a preview of the generated docs at https://theneuralbit.github.io/arrow-typedoc-0.20/. Compare this to the existing API docs at http://arrow.apache.org/docs/js/index.html. It properly reflects our two top-level modules, Arrow.dom and Arrow.node, and shows the objects exported within them. The existing docs give the impression of a bag of objects without any structure. There's still a lot of work to do to make these API docs useful, but I think this is a big step in the right direction (many thanks to @Gerrit0 for all the typedoc improvements that made this possible) . Some remaining issues that we could file follow-up jiras for: - Some objects are missing (e.g. Vector sub-classes like DateVector, FloatVector, ..). These also seem to be missing from the existing docs. It's possible this is a bug in typedoc? Will need further investigation. - Many classes and methods are still completely undocumented, so API docs tell users little aside from the structure of the code. Closes apache#9375 from TheNeuralBit/typedoc-0.20 Authored-by: Brian Hulette <hulettbh@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
Also ran `npm audit fix` This PR upgrades us beyond [typedoc 0.20](https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0) which made significant improvements to how re-exported objects are handled. I've uploaded a preview of the generated docs at https://theneuralbit.github.io/arrow-typedoc-0.20/. Compare this to the existing API docs at http://arrow.apache.org/docs/js/index.html. It properly reflects our two top-level modules, Arrow.dom and Arrow.node, and shows the objects exported within them. The existing docs give the impression of a bag of objects without any structure. There's still a lot of work to do to make these API docs useful, but I think this is a big step in the right direction (many thanks to @Gerrit0 for all the typedoc improvements that made this possible) . Some remaining issues that we could file follow-up jiras for: - Some objects are missing (e.g. Vector sub-classes like DateVector, FloatVector, ..). These also seem to be missing from the existing docs. It's possible this is a bug in typedoc? Will need further investigation. - Many classes and methods are still completely undocumented, so API docs tell users little aside from the structure of the code. Closes apache#9375 from TheNeuralBit/typedoc-0.20 Authored-by: Brian Hulette <hulettbh@gmail.com> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
Also ran
npm audit fix
This PR upgrades us beyond typedoc 0.20 which made significant improvements to how re-exported objects are handled. I've uploaded a preview of the generated docs at https://theneuralbit.github.io/arrow-typedoc-0.20/. Compare this to the existing API docs at http://arrow.apache.org/docs/js/index.html.
It properly reflects our two top-level modules, Arrow.dom and Arrow.node, and shows the objects exported within them. The existing docs give the impression of a bag of objects without any structure.
There's still a lot of work to do to make these API docs useful, but I think this is a big step in the right direction (many thanks to @Gerrit0 for all the typedoc improvements that made this possible) . Some remaining issues that we could file follow-up jiras for: