timsaucer commented on PR #1526: URL: https://github.com/apache/datafusion-python/pull/1526#issuecomment-4559550646
This is a good start. You can get around the problem you have building the docs if you have built the repo in your venv. This looks mostly like moving text around. I asked my agent to take a look and it picked up on a couple of things which I agree with. Mostly I'm thinking about the last point it makes. I was hoping to get a fresh look on what would be an ideal flow to the site. This is a good start though. -- ## Flow problems 1. **Two overlapping link lists on same page.** Overview adds "More specialized topics live on their own pages" (common-operations, arrow-interface, rendering, execution-metrics). Then near bottom a *second* "Related Topics" repeats arrow-interface, rendering, execution-metrics. Same 3 links twice. Redundant — reader sees them up top, then again at end. Pick one. Top list also includes `common-operations`; bottom omits it → inconsistent. Suggest: keep top roadmap brief, make bottom "Related Topics" the detailed one (or vice versa), not both. 2. **New `arrow-interface.rst` overlaps existing `io/arrow.rst`.** Both document `__arrow_c_stream__`. New page even links to `io/arrow` "for additional details." Two pages, same protocol. Pre-existing condition (old index already coexisted with io/arrow), so not a regression — but the reorg was the moment to dedupe, and didn't. Worth a comment. ## Does it close #1397? Partially, but reasonably. Issue: page "jumps around from common operations to Arrow C interface to rendering" + needs a home for execution metrics. PR pulls Arrow deep-dive into own page, adds lifecycle roadmap, links metrics page. Main complaint (Arrow deep-dive breaking the flow) — fixed. Gap: page *still* ends with reference-dump — "Core Classes", "Expression Classes", "Built-in Functions" — untouched. That's part of the "all over the place" the issue named. Out of scope is defensible, but #1397 asked for a "fresh look at organization," so a reviewer could push for more. Not a blocker. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
