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

Unify marking of depraceted API, deprications page #2020

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

Conversation

kontura
Copy link
Contributor

@kontura kontura commented Jan 24, 2025

It also adds ConfigMain to the docs (both cpp and python), mostly because it contains most of the deprecated API but it is an important class in general.

Closes: #865

@kontura kontura force-pushed the deprecations branch 2 times, most recently from 408303b to c303b8d Compare January 27, 2025 09:35
@mcurlej mcurlej assigned mcurlej and m-blaha and unassigned mcurlej Feb 3, 2025
Copy link
Member

@m-blaha m-blaha left a comment

Choose a reason for hiding this comment

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

Thank you!

- depraceted API needs to be marked with `[[deprecated]]` attribute
- depraceted API needs to be marked with `@deprecated` tag
- simplify and unify messages for deprecated API
Otherwise the build fails because we treat all warnings as errors.
@kontura kontura added the blocked Further work on issue or PR is blocked by something else label Feb 10, 2025
@kontura kontura removed the blocked Further work on issue or PR is blocked by something else label Feb 10, 2025
Copy link
Member

@jan-kolarik jan-kolarik left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for working on this.

@kontura
Copy link
Contributor Author

kontura commented Feb 11, 2025

This requires: rpm-software-management/ci-dnf-stack#1629

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.

Document deprecation for API functions
4 participants