Fix docstrings for DataFrame, and DataFrameReader #41
Conversation
sfc-gh-okostakis
requested review from
sfc-gh-kwagner,
sfc-gh-jdu and
sfc-gh-mabrennan
There was a problem hiding this comment.
Very good start! Do we have a plan to fix docstrings for other files?
One thing I'm a little bit concerned about is that the long docstring is not formatted (separated to multiple lines). Should we also enforced our auto-formatter to control the length of a docstring in a line? (we can add this flag psf/black#1802)
| Example 4 | ||
| Create a new DataFrame by applying transformations to other existing DataFrames:: | ||
|
|
||
| df_merged_data = df_catalog.join(df_prices, df_catalog["itemId"] == df_prices["ID"]) |
There was a problem hiding this comment.
Is getting a column from a dataframe using []-style accessors worth documenting?
There was a problem hiding this comment.
In Scala it was documented in the user-guide.
@sfc-gh-mabrennan FYI
| In addition, if you want to load only a subset of files from the stage, you can use the | ||
| `pattern <https://docs.snowflake.com/en/sql-reference/sql/copy-into-table.html#loading-using-pattern-matching>`_ | ||
| option to specify a regular expression that matches the files that you want to load. | ||
| In addition, if you want to load only a subset of files from the stage, you can |
There was a problem hiding this comment.
on line 308 above this, the sentence says " Loading the first two columns of a colon-delimited CSV file ..." but the example code seems to use a semicolon as a delimiter and not a colon. (This error also exists in the Scaladoc)
There was a problem hiding this comment.
Switched the delimiter to a colon in the example code (I copied the examples from there).
Each one of us should gradually fix the files for which they are the "code owners". Counting on @sfc-gh-mabrennan to step in and carry us the extra mile by assisting with examples and such.
In some cases creating a new line is not working well with sphinx. I would like to avoid having the auto-formatter messing up the strings and getting silly autodocs. If, however, our auto-formatter can be 100% compatible with sphinx's format, then we should utilize it. |
This PR aims to fix ALL details related to docstrings (for the purpose of autodocs) for the files dataframe.py and dataframe_reader.py