Skip to content

Add missing backslashes in readdlm docstrings #17236

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 2, 2016
Merged

Add missing backslashes in readdlm docstrings #17236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions base/docs/helpdb/Base.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3643,14 +3643,14 @@ readdlm(source, delim::Char, eol::Char)
"""
readdlm(source, delim::Char, T::Type; options...)

The end of line delimiter is taken as `n`.
The end of line delimiter is taken as `\\n`.
"""
readdlm(source, delim::Char, T::Type)

"""
readdlm(source, delim::Char; options...)

The end of line delimiter is taken as `n`. If all data is numeric, the result will be a
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.
"""
Expand All @@ -3660,15 +3660,15 @@ readdlm(source, delim::Char)
readdlm(source, T::Type; options...)

The columns are assumed to be separated by one or more whitespaces. The end of line
delimiter is taken as `n`.
delimiter is taken as `\\n`.
"""
readdlm(source, T::Type)

"""
readdlm(source; options...)

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
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.
"""
Expand Down
8 changes: 4 additions & 4 deletions doc/stdlib/io-network.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -588,25 +588,25 @@ Text I/O

.. Docstring generated from Julia source

The end of line delimiter is taken as ``n``\ .
The end of line delimiter is taken as ``\n``\ .

.. function:: readdlm(source, delim::Char; options...)

.. Docstring generated from Julia source

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.
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:: readdlm(source, T::Type; options...)

.. Docstring generated from Julia source

The columns are assumed to be separated by one or more whitespaces. The end of line delimiter is taken as ``n``\ .
The columns are assumed to be separated by one or more whitespaces. The end of line delimiter is taken as ``\n``\ .

.. function:: readdlm(source; options...)

.. Docstring generated from Julia source

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.
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')

Expand Down