Skip to content
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

Move datafmt docs out, update them a bit #17843

Merged
merged 1 commit into from
Aug 6, 2016
Merged

Move datafmt docs out, update them a bit #17843

merged 1 commit into from
Aug 6, 2016

Conversation

kshyatt
Copy link
Contributor

@kshyatt kshyatt commented Aug 5, 2016

These docstrings could stand some real improvement so if someone has suggestions, I'm happy to update them (or you can just push to my branch).

@kshyatt kshyatt added docs This change adds or pertains to documentation io Involving the I/O subsystem: libuv, read, write, etc. labels Aug 5, 2016
@kshyatt kshyatt merged commit ed125e9 into master Aug 6, 2016
@kshyatt kshyatt deleted the ksh/docdatafmt branch August 6, 2016 21:45
@@ -624,7 +624,7 @@ Text I/O

The columns are assumed to be separated by one or more whitespaces. The end of line delimiter is taken as ``\n``\ . If all data is numeric, the result will be a numeric array. If some elements cannot be parsed as numbers, a heterogeneous array of numbers and strings is returned.

.. function:: writedlm(f, A, delim='\\t')
.. function:: writedlm(f, A, dl='\\t'; opts)
Copy link
Contributor

Choose a reason for hiding this comment

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

why delim everywhere but here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because in the arg list it's dl. I can change it back :)

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah I think doc consistency will be more visible than code naming consistency. we could change the latter too if we feel like it.

Copy link
Contributor

Choose a reason for hiding this comment

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

bump

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ty for the reminder i will take care of it tonight :)

"""
writedlm
digamma
Copy link
Contributor

@tkelman tkelman Aug 7, 2016

Choose a reason for hiding this comment

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

you moved the docstring for digamma already, I think adding it back was a rebase mistake

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 did aaaaa

tkelman pushed a commit that referenced this pull request Aug 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation io Involving the I/O subsystem: libuv, read, write, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants