Github user HyukjinKwon commented on the issue:

    https://github.com/apache/spark/pull/15053
  
    Oh, I meant just don't touch the `globs` in `_test()` but just print the 
global dataframes (which should be rather `show()` to show the contents) so 
that users can understand the input and output. So, my scenario is, users open 
the doc and see the input dataframes first and then check the function 
documentation they want.
    
    I do like the idea of defining each within each docstring but maybe we 
could try the minimal change suggestion to reach the same goal.
    
    I guess she meant defining the global dataframes within the package 
docstring which is, for example,
    
    ```python
    """
    # here
    """
    
    import doctest
    import sys
    ...
    ```
    
    However, after investigating, it seems we can't easily do that. So, I 
suggested to print them in the package docstring such as
    
    ```python
    """
    >>> df.show()
    +-----+
    |field|
    +-----+
    |value|
    |value|
    +-----+
    """
    
    import doctest
    import sys
    ...
    ```
    
    rather than defining them in the package docstring.
    



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org

Reply via email to