DOC: update DataFrame.to_records #20191

samuelsinayoko · 2018-03-10T16:03:50Z

TomAugspurger · 2018-03-10T16:26:09Z

pandas/core/frame.py

+        DataFrame.from_records: convert structured or record ndarray
+            to DataFrame.
+        numpy.recarray: ndarray that allows field access using
+            attributes, analogous to typed (typed) columns in a


Why typed in the parenthesis?

Sorry, typo! Fixed in 823862b.

TomAugspurger · 2018-03-10T16:26:21Z

pandas/core/frame.py

+
+        Examples
+        --------
+


No blank line here

Fixed in 2d0a3bb.

TomAugspurger · 2018-03-10T16:26:31Z

pandas/core/frame.py

+        >>> df = pd.DataFrame({'A': [1, 2], 'B': [0.5, 0.75]},
+        ...                   index=['a', 'b'])
+        >>> df
+           A  B


Need some extra spaces here

Try pytest --doctest-modules pandas/core/frame.py -k to_records to validate that it's correct.

👍.
Renamed the columns at the last minute to save space and looks like he'd messed up the tests. Not sure how it sill passed the validate_docstring.py script though.
Fixed in 5f6e1c5.

TomAugspurger · 2018-03-10T18:20:08Z

pandas/core/frame.py

+        >>> df = pd.DataFrame({'A': [1, 2], 'B': [0.5, 0.75]},
+        ...                   index=['a', 'b'])
+        >>> df
+           A  B


column names A and B should line up with the data

Fixed in 5f6e1c5.

samuelsinayoko · 2018-03-10T18:29:16Z

TomAugspurger · 2018-03-10T18:30:18Z

pandas/core/frame.py

        convert_datetime64 : boolean, default True
            Whether to convert the index to datetime.datetime if it is a
-            DatetimeIndex
+            DatetimeIndex.

        Returns
        -------
        y : recarray


Ah sorry one last change. Could you make this y : numpy.recarray. And maybe say that in the opening line. "Convert the DataFrame to a NumPy record array"

No probs. Fixed in b1d0b09.

TomAugspurger · 2018-03-11T11:58:03Z

@TomAugspurger

samuelsinayoko added 4 commits March 10, 2018 15:23

Update to_records docstring.

bcf416c

- Minor changes (missing dots, newlines) to make tests pass. - More examples.

Fix html docs.

8d0ee56

Missing newlines.

Reword datetime type information.

b03dda7

flake8 errors

e7b4cf2

TomAugspurger reviewed Mar 10, 2018

View reviewed changes

TomAugspurger added the Docs label Mar 10, 2018

TomAugspurger added this to the 0.23.0 milestone Mar 10, 2018

TomAugspurger added the IO Data IO issues that don't fit into a more specific label label Mar 10, 2018

jreback added the Reshaping Concat, Merge/Join, Stack/Unstack, Explode label Mar 10, 2018

jreback removed this from the 0.23.0 milestone Mar 10, 2018

samuelsinayoko added 2 commits March 10, 2018 18:14

Fix typo (duplicated type)

823862b

Remove unwanted blank line after Examples.

2d0a3bb

TomAugspurger reviewed Mar 10, 2018

View reviewed changes

Few more changes

b1d0b09

TomAugspurger merged commit 6d7272a into pandas-dev:master Mar 11, 2018

TomAugspurger added this to the 0.23.0 milestone Mar 11, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

DOC: update DataFrame.to_records #20191

DOC: update DataFrame.to_records #20191

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

DOC: update DataFrame.to_records #20191

DOC: update DataFrame.to_records #20191

Uh oh!

Conversation

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!