search

JakobGM / patito

A data modelling layer built on top of polars and pydantic
MIT License
252 stars 23 forks source link

docs: Remove database & SQL references, remove title underlines to comply with Google docstring format, fix patito.Field docstring, error on front page #72

Closed nameloCmaS closed 1 month ago

nameloCmaS commented 3 months ago

Fixes various issues with the documentation:

  1. Remove database & SQL references - these were removed in #32. Delete files and references in .rst files (I had read the whole documentation for the database module thinking that it was a nice feature, and realised it had been removed - so thought I should help out and remove it for you!)
  2. Remove title underlines to comply with Google docstring format to remove sphinx warnings.
  3. fix patito.Field docstring.
  4. Removes visible backticks on front page of docs.

This leaves the below sphinx warnings, tried importing FrameInitTypes in different modules, but didn't help:

WARNING: Failed guarded type import with ModuleNotFoundError("No module named 'deltalake'")
WARNING: Cannot resolve forward reference in type annotations of "patito.DataFrame": name 'FrameInitTypes' is not defined
WARNING: Cannot resolve forward reference in type annotations of "patito.Model.DataFrame": name 'FrameInitTypes' is not defined
thomasaarholt commented 1 month ago

This is great and really thorough! Thank you so much!