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

Fix some documentation and deprecation issues #16585

Merged
merged 6 commits into from
May 27, 2016

Conversation

tkelman
Copy link
Contributor

@tkelman tkelman commented May 25, 2016

ref #16561

the dict comprehension is still mentioned in the table at https://github.com/tkelman/julia/blob/d538f2920a5a9b7e0e70280a419e2f5e8fb9772a/doc/devdocs/ast.rst#bracketed-forms, I'm not sure what to replace it with

@JeffBezanson
Copy link
Member

Those table entries can just be removed (whether before or after the deprecation is removed, I don't know). They won't occur in ASTs any more.

@tkelman
Copy link
Contributor Author

tkelman commented May 25, 2016

I think it's probably best to remove documentation at the same time as deprecating something, otherwise it'll sit there for who knows how long. Removing deprecations is usually a deletion of a big chunk of code, and it's too easy to skip the part about searching carefully through any remaining mentions of what you're deleting.

add quotes around (0,0)

Adjust grammar in some comments and docstrings
see discussion in JuliaLang#16561, deprecations should be flagged, found, and removed
in base - if you need to include code with deprecations in userimg.jl, then
add --depwarn=no manually when building that custom image
@tkelman tkelman force-pushed the tk/docfixes branch 2 times, most recently from 334d659 to cdc9e62 Compare May 25, 2016 21:13
there are a few more in the FFTW deprecations that should be removed soon
msync, iseltype, inf, nan, complement, complement!
etc etc etc
@tkelman
Copy link
Contributor Author

tkelman commented May 26, 2016

Review appreciated, will merge later if no objections.

@JeffBezanson
Copy link
Member

👍 Very nice.

@tkelman
Copy link
Contributor Author

tkelman commented May 27, 2016

Our various deprecation sprees may have a few conflicts. And https://github.com/tkelman/julia/blob/60c269d9e38f0416635cef8d7e543dcc54bd98b4/base/deprecated.jl#L504-L509 will give a warning (@deprecate wasn't quite capable of handling the new form as I think you saw before), but I think the solution there will be to just delete the 0.4 deprecations. We're not quite in 0.5-pre feature freeze yet but we're getting really close, and it's been 6+ months with all of the old deprecations giving warnings.

@JeffBezanson
Copy link
Member

Yeah, that's fine.

@JeffBezanson JeffBezanson merged commit f61ea53 into JuliaLang:master May 27, 2016
@tkelman tkelman deleted the tk/docfixes branch May 27, 2016 00:29
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.

2 participants