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

Add preview documentation section #7281

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Add preview documentation section #7281

merged 4 commits into from
Sep 12, 2023

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Sep 11, 2023

Adds a basic documentation section for preview mode based on the FAQ entry and versioning RFC.

I intend to expand this with more details as we play with the user experience here. We could also consider generating an enumerated list of preview features 🤷‍♀️

@zanieb zanieb added the documentation Improvements or additions to documentation label Sep 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Sep 11, 2023

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

@zanieb zanieb marked this pull request as ready for review September 12, 2023 15:30
@zanieb zanieb enabled auto-merge (squash) September 12, 2023 15:36
@codspeed-hq
Copy link

codspeed-hq bot commented Sep 12, 2023

CodSpeed Performance Report

Merging #7281 will degrade performances by 5.33%

Comparing zanie/preview-docs (2198bb7) with main (773ba5f)

Summary

❌ 5 regressions
✅ 20 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main zanie/preview-docs Change
linter/all-rules[numpy/ctypeslib.py] 33 ms 34.8 ms -5.33%
linter/all-rules[unicode/pypinyin.py] 15.2 ms 15.7 ms -3.02%
linter/all-rules[numpy/globals.py] 4 ms 4.1 ms -2.58%
linter/all-rules[pydantic/types.py] 69.5 ms 73 ms -4.75%
linter/all-rules[large/dataset.py] 156.8 ms 163.2 ms -3.95%

@zanieb zanieb merged commit 008da95 into main Sep 12, 2023
@zanieb zanieb deleted the zanie/preview-docs branch September 12, 2023 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants