re-export expression2List() with deprecation message #441
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@ncborcherding People reading old tutorials / with old code may need a way to figure out why things are not working like in #440 and likely dont read
NEWS.mdAlso the current approach is that an error is thrown when trying to use the exported function, but if the user is persistent on using it, they are forced by details to read the documentation, leading to them seeing the deprecation reason. If they are still persistent then I've given them an option to set the
forceargument to TRUE. It may be even helpful psychologically to make the process even harder by forcing users to use scRepertoire:::.expression2List() after they read the docs but I think people who get to this point probably just need it for something quick...Also note that the documentation is tagged with
@keywords internalso no need to worry about people re-discovering it. pkgdown should either just straight up not display it in reference of it will have the deprecation tag graphic next to it.