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

Documentation for deprecated methods #13051

Open
jakebolewski opened this issue Sep 10, 2015 · 2 comments
Open

Documentation for deprecated methods #13051

jakebolewski opened this issue Sep 10, 2015 · 2 comments
Labels
docs This change adds or pertains to documentation docsystem The documentation building system

Comments

@jakebolewski
Copy link
Member

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:

  • A standardized way of formatting that a method is deprecated in its docstring.
  • An expectation that when a method is deprecated, a specific docstring is updated.
  • A way for the doc system to introspect that a particular method / type is deprecated.
@jakebolewski jakebolewski added docs This change adds or pertains to documentation docsystem The documentation building system labels Sep 10, 2015
@JeffBezanson
Copy link
Member

Related, needs similar reflection features: #3526

@ScottPJones
Copy link
Contributor

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

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 docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

3 participants