Skip to content

Where is documentation of Hastructure ?

Shawn Zhang edited this page Jan 9, 2024 · 2 revisions

Where is documentation of Hastructure ?

The code documentation is preparing gradually during the evolving of code base. The code documentation aims to be generated by haddock. But I can't have a precise estimation on the timeline on when to finalized the haddock comment in the code base.

Is Python wrapper document good enough ?

Close Enough, the regression tests are written in Python. But Python wrapper has couple glue codes to bridge the Pythonic/functional code to Aeson/Haskell world, these code may introduce certain discrepancy between Python doc and Haskell implementation.

While samples codes in the document site is being migrated to regression test coverage.