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

deprecate print_escaped, print_unescaped, and print_joined #16603

Merged
merged 1 commit into from
May 27, 2016

Conversation

JeffBezanson
Copy link
Member

Part of #14052. Some redundant functions.

@@ -784,12 +784,12 @@ Equivalent to `stat(file).mode`
filemode

"""
print_joined(io, items, delim, [last])
join(io, items, delim, [last])
Copy link
Contributor

Choose a reason for hiding this comment

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

removing square brackets around last or not? should be consistent between here and the rst docstring at https://github.com/JuliaLang/julia/pull/16603/files#diff-5024f6efcbbb7500d181c34103c2576a

Copy link
Member Author

Choose a reason for hiding this comment

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

I wasn't sure if the signature-matching supported that, since it doesn't allow the brackets on the line below specifying which method is documented.

Copy link
Contributor

Choose a reason for hiding this comment

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

by "the line below" do you mean the part outside the docstring? that needs to be valid julia syntax

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes I mean the part outside the docstring. Is it ok for the signature to have the brackets, but the part outside not to?

Copy link
Contributor

@tkelman tkelman May 26, 2016

Choose a reason for hiding this comment

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

Yeah. The brackets are just for presentation (and rst genstdlib matching), the part outside controls which method this particular docstring gets attached to, AIUI. I think we may eventually want to move from the bracket convention to strictly using Julia syntax in docstrings, but that's a decision for another day.

@JeffBezanson JeffBezanson merged commit dabfa73 into master May 27, 2016
@JeffBezanson JeffBezanson deleted the jb/misc_io_deprecations branch May 27, 2016 05:50
@tkelman
Copy link
Contributor

tkelman commented Jul 19, 2016

needs NEWS mention

tkelman added a commit to tkelman/DataFrames.jl that referenced this pull request Jul 19, 2016
ararslan pushed a commit to JuliaData/DataFrames.jl that referenced this pull request Jul 19, 2016
* Compat minimum version is 0.8.0 for show/writemime and unsafe_string

* Be specific about print_escaped renaming

for the sake of bisecting
ref JuliaLang/julia#16603

* Remove probably-unnecessary at-static
@StefanKarpinski StefanKarpinski added the needs docs Documentation for this change is required label Jul 19, 2016
@ranjanan
Copy link
Contributor

ranjanan commented Aug 9, 2016

@StefanKarpinski I think your new "news" label can be applied here? Oh nevermind, there's already a news mention.

@tkelman tkelman removed the needs docs Documentation for this change is required label Aug 9, 2016
maximerischard pushed a commit to maximerischard/DataFrames.jl that referenced this pull request Sep 28, 2016
* Compat minimum version is 0.8.0 for show/writemime and unsafe_string

* Be specific about print_escaped renaming

for the sake of bisecting
ref JuliaLang/julia#16603

* Remove probably-unnecessary at-static
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants