Add tutorial for bindings #102
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
inknos
force-pushed
the
ns-tutorial-python
branch
2 times, most recently
from
1c5a8e9 to
ccefaff
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
from
ccefaff to
64a1cec
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
from
64a1cec to
c79f048
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
from
c79f048 to
3984149
Compare
|
I can confirm that the |
inknos
force-pushed
the
ns-tutorial-python
branch
from
3984149 to
2ae1216
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
from
2ae1216 to
3f329df
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
3 times, most recently
from
67c433a to
452105a
Compare
inknos
force-pushed
the
ns-tutorial-python
branch
from
452105a to
a9b509e
Compare
This commit adds the main structure for the documentation of language bindings. It serves its purpose by showing a minimal working example for python3. The dir test/python3/libdnf5/tutorial is soft-linked to doc/tutorials/tests/bindings/python3. This allows us to use the documentation snippets in testing. The purpose of including tutorials' code in unit tests is to ensure they would be interpreted without errors if run in sequence. Specifically, these tests do not assert anything on the results one could get by calling the API. They provide testing on the functional part of dnf5's language bindings. Inside test/tutorial/binding/python3/test_tutorial.py each snippet is imported via `exec`. Although this is usually a bad practice, calling `exec` allows the tests to run all the snippets in a sequence, as if a user would copy-paste the code in a single example. As stated previously, these tests do not assert anything on the results of the called API functions. Hence, `exec` is considered to be safe in this instance.
inknos
force-pushed
the
ns-tutorial-python
branch
from
a9b509e to
f8afe85
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pr adds documentation for language bindings.
Currently, the PR aims to replicate the c++ tutorial section in python and, subsequently, to other languages.
To test tutorials the dir
test/python3/libdnf5/tutorialis soft-linked todoc/tutorials/tests/bindings/python3There are a few things that can be reviewed already and some that are still work in progress.
Eventually this work will be the base to implement tutorial for other bindings