JuliaLang / julia

The Julia Programming Language
https://julialang.org/
MIT License
45.77k stars 5.49k forks source link

Documentation for deprecated methods #13051

Open jakebolewski opened 9 years ago

jakebolewski commented 9 years ago

We need a standardized way to document that a method is deprecated. v0.4 had a lot of deprecations but the only warning was emitted at runtime when the function was called. None of the docs were updated and no warning was thrown for these methods when calling help?>. When deprecated functions are removed the docs could persist for 1 more release cycle.

What we need going forward:

JeffBezanson commented 9 years ago

Related, needs similar reflection features: #3526

ScottPJones commented 9 years ago

Should things that were deprecated in v0.4 start to be removed totally in master (v0.5-dev?). I noticed the documentation problem yesterday:

help?> isvalid
search: isvalid is_valid_utf8 is_valid_char is_valid_utf32 is_valid_utf16

  isvalid(T, value) -> Bool
...
help?> is_valid_char
search: is_valid_char is_valid_ascii is_valid_utf8 is_valid_utf32 is_valid_utf16