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

Implement ci-dnf-stack/unit tests and documentation for Python API #213

Open
10 of 21 tasks
kontura opened this issue Jan 3, 2023 · 1 comment
Open
10 of 21 tasks
Assignees
Labels
epic Priority: MEDIUM Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take
Milestone

Comments

@kontura
Copy link
Contributor

kontura commented Jan 3, 2023

Every function on dnf5 Python API should be documented and should have a test to verify that it works. The tests should be unit tests if possible or a CI tests if necessary based on the required setup for the given test.

In general we should first create documentation for a function and then based on it create the tests.

We need tests for:

libdnf5.base:

[libdnf::advisory]:

libdnf5,repo:

  • RepoQuery
  • [RepoSack]
    • add missing API docs
    • don't forget to mention how variables are substituted when creating repos

libdnf5.rpm:

(The list will be continually updated and links should point to Python docs not cpp.)

@mcurlej mcurlej added this to DNF team Jan 18, 2023
@github-project-automation github-project-automation bot moved this to Backlog in DNF team Jan 18, 2023
@j-mracek j-mracek added the Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take label Aug 29, 2023
@j-mracek j-mracek moved this from Backlog to Todo in DNF team Aug 29, 2023
@kontura kontura self-assigned this Oct 23, 2023
@kontura kontura moved this from Todo to In Progress in DNF team Oct 23, 2023
@kontura kontura changed the title Implement ci-dnf-stack tests and documentation for Python API Implement ci-dnf-stack/Unit tests and documentation for Python API Oct 23, 2023
@kontura kontura changed the title Implement ci-dnf-stack/Unit tests and documentation for Python API Implement ci-dnf-stack/unit tests and documentation for Python API Oct 23, 2023
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
kontura added a commit to kontura/dnf5 that referenced this issue Oct 24, 2023
@kontura
Copy link
Contributor Author

kontura commented Oct 24, 2023

Advisory docs and tests: #987

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Priority: MEDIUM Triaged Someone on the DNF 5 team has read the issue and determined the next steps to take
Projects
Status: In Progress
Development

No branches or pull requests

4 participants