Skip to content

docs: add hyperlinks to str.get_dummies #12350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

wjt
Copy link
Contributor

@wjt wjt commented Feb 16, 2016

The description used in the summary table is the first sentence of
str_get_dummies()'s docstring, edited to match the style of other
summaries.

I tried to build this branch locally – the Method Summary section doesn't render with this change and I can't see why, it looks syntactically correct to me…

@jreback jreback added Docs Strings String extension data type and string data labels Feb 16, 2016
@jreback jreback added this to the 0.18.0 milestone Feb 16, 2016
@@ -1035,7 +1035,8 @@ def get_dummies(data, prefix=None, prefix_sep='_', dummy_na=False,
2 0 1
3 0 0
4 0 0
See also ``Series.str.get_dummies``.

See also :meth:`~Series.str.get_dummies`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead do like:

See Also
------------
Series.str.get_dummies

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this change, rebuilding locally now to test…

@wjt wjt force-pushed the docs-str.get_dummies branch from a35c5b2 to 3b0019e Compare February 16, 2016 15:46

See Also
------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean to show it this way, but the ---- should be the same length as the words

The description used in the summary table is the first sentence of
str_get_dummies()'s docstring, edited to match the style of other
summaries.
@wjt wjt force-pushed the docs-str.get_dummies branch from 3b0019e to 4cd46e1 Compare February 16, 2016 16:22
@jreback jreback closed this in fc321fb Feb 17, 2016
@jreback
Copy link
Contributor

jreback commented Feb 17, 2016

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Strings String extension data type and string data
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants