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

docs: add central note about experimental functions #1624

Merged
merged 2 commits into from
Dec 18, 2024
Merged

Conversation

maelle
Copy link
Contributor

@maelle maelle commented Dec 10, 2024

"Use lifecycle for all experimental functions, make a central note in the documentation." is part of the R Consortium proposal.

Have we missed functions that should have the experimental badge? If so, how could I identify them?

Local preview:

image

@maelle maelle requested a review from szhorvat December 10, 2024 10:36
Copy link
Contributor

aviator-app bot commented Dec 10, 2024

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 PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.


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.

@szhorvat
Copy link
Member

Have we missed functions that should have the experimental badge? If so, how could I identify them?

I'm not sure. I wouldn't worry too much, I don't think we missed much.

If you'd like to make sure, the way to go is to check PRs from the past few months and see if we ever forgot the "experimental" marker. Anything that is "experimental" in the C core should also be experimental in R. Newly exposed functions that are NOT experimental in C may or may not be experimental in R, according to your and Kirill's judgement.

@szhorvat
Copy link
Member

I had a look through recent "feat:" PRs and I don't think we missed anything.

@maelle
Copy link
Contributor Author

maelle commented Dec 17, 2024

Thanks so much @szhorvat!!

@krlmlr could we please merge this harmless PR?

@krlmlr krlmlr enabled auto-merge (squash) December 18, 2024 05:54
@krlmlr
Copy link
Contributor

krlmlr commented Dec 18, 2024

Thanks!

@krlmlr krlmlr merged commit 7bf4902 into main Dec 18, 2024
6 checks passed
@krlmlr krlmlr deleted the experimental branch December 18, 2024 06:08
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.

3 participants