LineaLabs / lineapy

Move fast from data science prototype to pipeline. Capture, analyze, and transform messy notebooks into data pipelines with just two lines of code.
https://lineapy.org
Apache License 2.0
661 stars 58 forks source link

Document Fixes for October Release #835

Closed andycui97 closed 1 year ago

andycui97 commented 1 year ago

Description

Various Documentation fixes for Oct

Type of change

How Has This Been Tested?

Local doc build

yoonspark commented 1 year ago

Given the PR description, I focused my review on the newly created RTD pages under internals section, i.e.,

These pages look fairly good as internal documentation to quickly capture essence of our major data structures (e.g., NodeCollection), which is important to remember + build on the past work.

If we eventually intend internals documentation to become a more user/contributor-facing whitepaper detailing how the system works, then it needs more polishing/fleshing-out. However, this level of refinement is not necessary at the moment as our current intention is to have it mostly for internal use.

andycui97 commented 1 year ago

Given the PR description, I focused my review on the newly created RTD pages under internals section, i.e.,

  • graph_breakdown.rst
  • codegen.rst

These pages look fairly good as internal documentation to quickly capture essence of our major data structures (e.g., NodeCollection), which is important to remember + build on the past work.

If we eventually intend internals documentation to become a more user/contributor-facing whitepaper detailing how the system works, then it needs more polishing/fleshing-out. However, this level of refinement is not necessary at the moment as our current intention is to have it mostly for internal use.

Sgtm. Agree, right now just want to put rough ideas in internals so we at least have something to point to. Don't expect these to be user facing or even heavily referenced by most contributors.