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

remove deprecated funcs from docs #845

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

lkarthee
Copy link
Member

@lkarthee lkarthee commented Feb 2, 2024

Edit: Removed from docs

Original:
Deprecated function docs do not have links - the names are just displayed as text.

https://hexdocs.pm/explorer/Explorer.DataFrame.html#functions-deprecated

@lkarthee lkarthee force-pushed the deprecated_func_links branch from b521cd9 to 7b52bc0 Compare February 2, 2024 06:03
@josevalim
Copy link
Member

I'd rather @doc false them and not have them show up in the docs. Thoughts?

@lkarthee
Copy link
Member Author

lkarthee commented Feb 2, 2024

Personally speaking, I would like to see deprecated functions show up in docs until they are removed.

Do you think mentioning in changelog and compiler warnings are sufficient?

As for PR, anything is fine.

@josevalim
Copy link
Member

The idea is that only old code based call it and in their case the deprecation warning has the relevant into to migrate.

@lkarthee lkarthee force-pushed the deprecated_func_links branch from 7b52bc0 to 8a81408 Compare February 2, 2024 11:37
@lkarthee
Copy link
Member Author

lkarthee commented Feb 2, 2024

removed deprecated from docs

@lkarthee lkarthee changed the title deprecated funcs - new func names as links deprecated funcs remove from docs Feb 2, 2024
@lkarthee lkarthee changed the title deprecated funcs remove from docs remove deprecated funcs from docs Feb 2, 2024
@josevalim josevalim merged commit b902d23 into elixir-explorer:main Feb 2, 2024
3 checks passed
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

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