search

libfuse / pyfuse3

Python 3 bindings for libfuse 3 with asynchronous API (Trio compatible)
https://pyfuse3.readthedocs.io/
Other
162 stars 48 forks source link

Type Annotations - Small follow up #48

Closed odgalvin closed 2 years ago

odgalvin commented 2 years ago

These are just some small changes to tidy up after my last PR. Add a copyright/license comment to the stubs in the style of the existing files and include it in the manifest, expose the types correctly, and fix some typos and stuff I noticed while I was at it.

Nikratio commented 2 years ago

Could you take another look at this? When building the documentation (setup.py build_sphinx) we now get lots of errors:

WARNING: py:class reference target not found: InodeT
/home/nikratio/in-progress/pyfuse3/src/_pyfuse3.py:docstring of _pyfuse3.Operations.symlink:: WARNING: py:class reference target not found: FileNameT
/home/nikratio/in-progress/pyfuse3/src/_pyfuse3.py:docstring of _pyfuse3.Operations.symlink:: WARNING: py:class reference target not found: FileNameT
/home/nikratio/in-progress/pyfuse3/src/_pyfuse3.py:docstring of _pyfuse3.Operations.unlink:: WARNING: py:class reference target not found: InodeT
/home/nikratio/in-progress/pyfuse3/src/_pyfuse3.py:docstring of _pyfuse3.Operations.unlink:: WARNING: py:class reference target not found: FileNameT
/home/nikratio/in-progress/pyfuse3/src/_pyfuse3.py:docstring of _pyfuse3.Operations.write:: WARNING: py:class reference target not found: FileHandleT
generating indices... genindex py-modindex done

I think you either need to add documentation for these types, or convince Sphinx/Autodoc that they should not be considered.