search

openSUSE / libpathrs

C-friendly API to make path resolution safer on Linux.
GNU Lesser General Public License v3.0
83 stars 6 forks source link

add documentation to Python bindings #76

Closed cyphar closed 1 month ago

cyphar commented 1 month ago

At the moment our Python bindings are missing documentation. You can probably base the documentation on the docs in include/pathrs.h and the Go bindings' documentation.

cyphar commented 1 month ago

9b843e4457d30f6f769b7f5143ab1ea5d8353ff7 should be enough as a first pass. It would be nice for the PROC_* constants to be documented but there isn't a nice way to do this in Python (though apparently Sphinx has a way of doing it with #: ... comments?).