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.

Sign up for GitHub

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

Jump to bottom

Apply consistent approach to function deprecation #7

Open

4 tasks

cornelmpop opened this issue Nov 15, 2023 · 0 comments

Open

4 tasks

Apply consistent approach to function deprecation #7

cornelmpop opened this issue Nov 15, 2023 · 0 comments

Assignees

Labels

Milestone

Owner

cornelmpop commented Nov 15, 2023 •

edited

Loading

Functions that are deprecated should be documented in a similar way:

lifecycle tag - deprecated or superseded.
title and description: (Deprecated) - as done in align_pca.R.
description: explain rationale for deprecation and what function takes over, if any, with a direct link to the latter. If possible, provide an example of how the same functionality can be obtained through the function that replaces it.
Add a document where this process is documented (for the future).

cornelmpop self-assigned this

cornelmpop added the enhancement label

cornelmpop added this to the 0.6.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment