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

Doc: remove beta note from the main doc page #709

Merged
merged 2 commits into from
Nov 29, 2024
Merged

Conversation

greschd
Copy link
Member

@greschd greschd commented Nov 26, 2024

Remove the note that PyACP is in beta from the main documentation page.

Switch the trove classifier to indicate that PyACP is stable.

Closes #687.

@greschd
Copy link
Member Author

greschd commented Nov 26, 2024

We may want to wait with merging this until shortly before release.

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.99%. Comparing base (7d2e00a) to head (c4fa488).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #709   +/-   ##
=======================================
  Coverage   94.99%   94.99%           
=======================================
  Files         109      109           
  Lines        5695     5695           
  Branches      322      322           
=======================================
  Hits         5410     5410           
  Misses        284      284           
  Partials        1        1           
Flag Coverage Δ
direct-launch 91.58% <ø> (ø)
minimum-deps 93.19% <ø> (ø)
python-3.10 94.25% <ø> (ø)
python-3.11 94.18% <ø> (ø)
python-3.12 94.38% <ø> (ø)
server-2024R2 90.81% <ø> (ø)
server-2025R1 94.18% <ø> (ø)
server-2025R2 94.18% <ø> (ø)
server-latest 94.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@greschd greschd marked this pull request as ready for review November 28, 2024 18:59
@greschd
Copy link
Member Author

greschd commented Nov 28, 2024

We may want to wait with merging this until shortly before release.

Since we're about to publish a release candidate, I think it's ok to remove now.

Remove the note that PyACP is in beta from the main documentation
page.

Switch the trove classifier to indicate that PyACP is stable.
@greschd greschd force-pushed the docs/remove_beta_note branch from bf93f75 to 5260096 Compare November 29, 2024 12:36
Copy link
Contributor

@roosre roosre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about adding a compatibility section like the one at the bottom of this page in DPF Composites? Or at least a section which informs the customers that 2025 R1 is needed to run all features. I couldn't find any reference to minimum version of the unified installer.

@greschd
Copy link
Member Author

greschd commented Nov 29, 2024

What do you think about adding a compatibility section like the one at the bottom of this page in DPF Composites? Or at least a section which informs the customers that 2025 R1 is needed to run all features. I couldn't find any reference to minimum version of the unified installer.

Yes, I think we should do that. The individual classes have a note

Added in ACP server version XYZ.

in their API reference, but it would make sense to collect that information onto one page.

I was also considering adding some description of how to upgrade from the beta version to the full release. While it was explicitly stated in the beta note that the API may change, I think we should still give a brief overview of changes and how to migrate the code.

I added #724 to track this.

@greschd greschd enabled auto-merge (squash) November 29, 2024 13:38
@greschd greschd merged commit 98ea997 into main Nov 29, 2024
32 checks passed
@greschd greschd deleted the docs/remove_beta_note branch November 29, 2024 13:51
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.

Remove beta note from documentation
2 participants