mesejo commented on issue #440:
URL: 
https://github.com/apache/arrow-datafusion-python/issues/440#issuecomment-1666842213

   @alamb Thanks for the feedback 
   
   > Maybe you have time to pretend you are a first time user and and figure 
out what is not clear or where the rough edges are. Ideally you could turn that 
experience into a guide to help others.
   
   I open a [PR](https://github.com/apache/arrow-datafusion-python/pull/445) 
with a draft for the User Guide 😃. While I was writing the guide, I noticed two 
issues that have a huge impact on the UX and are simple to solve:
   
   1. The IDE cannot provide hints (or autocompletion) because there is no 
typing information.  
   2. There are no examples of how to use each method (or function)
   
   For solving 1. we could follow the PyO3 
[guide](https://pyo3.rs/v0.19.1/python_typing_hints) and add information in 
.pyi files. 
   
   For 2. one alternative is to wrap the methods and functions in Python and 
add docstrings to them (similar to what polars do, see 
[this](https://github.com/pola-rs/polars/blob/main/py-polars/polars/expr/expr.py#L6980-L7007)
 for example). 
   
   What are your thoughts?  


-- 
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]

Reply via email to