astronomer / astro-sdk

Astro SDK allows rapid and clean development of {Extract, Load, Transform} workflows using Python and SQL, powered by Apache Airflow.
https://astro-sdk-python.rtfd.io/
Apache License 2.0
329 stars 40 forks source link

Nit: Param docstring for `load_pandas_dataframe_to_table`: "Local or remote filepath" implies incorrect type #2162

Open thomkav opened 1 month ago

thomkav commented 1 month ago

Hey Astro,

Loving the software so far. This is a documentation nit, no bug here. The param docstring for all load_pandas_dataframe_to_table functions implies that source_dataframe is Local or remote filepath. The typing and actual implementation indicates a Dataframe is expected. I happened to be testing postgres, but I checked that documentation for other connection types under databases.base have the same error.

https://github.com/astronomer/astro-sdk/blob/149dd9e5f98aaa1bbf918d9deb0c297c124db8b9/python-sdk/src/astro/databases/base.py#L649