Skip to content

docs: link to replacements of deprecated functions #1823

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

szhorvat
Copy link
Member

@szhorvat szhorvat commented Apr 12, 2025

This is a simple find-and-replace job to actually link to replacements of deprecated functions instead of simply mentioning them.

Is there a reason it wasn't done this way? Perhaps it is not standard in the R world?

Do we want [`some_fun()`] (inline code) or simply [some_fun()] (not in code style)? I see both styles used at the moment.

I am hoping this encourages people to upgrade to the non-deprecated alternative more quickly. I still see tutorials published with the old names ...

The search pattern was:

was renamed to (`.+?`)

Copy link
Contributor

aviator-app bot commented Apr 12, 2025

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This pull request is currently open (not queued).

How to merge

To merge this PR, comment /aviator merge or add the mergequeue label.


See the real-time status of this PR on the Aviator webapp.
Use the Aviator Chrome Extension to see the status of your PR within GitHub.

@krlmlr
Copy link
Contributor

krlmlr commented Apr 29, 2025

Would you like to share the code that did the search+replace? We might run into conflicts, I'd also like to tweak a detail.

@szhorvat
Copy link
Member Author

There's no code. I did it with a text editor, and regex find/replace, so that I could review at least a subset of replacements before proceeding.

@krlmlr
Copy link
Contributor

krlmlr commented Apr 29, 2025

I now see you asked, [some_fun()] is preferred and could be changed everywhere as part of this PR. I'll remember merging this when all other ready PRs are done to keep conflicts contained.

@szhorvat
Copy link
Member Author

[some_fun()] is preferred

I can fix this without too much trouble.

@szhorvat
Copy link
Member Author

@krlmlr, this is done now.

Replacement across all files in /R:

\[`(.+?\(\))`\] $\longrightarrow$ [$1]

I didn't notice anything going wrong.

But I did notice an unusual way to refer to a class (use of parentheses), which is also fixed now.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants