Skip to content

Add stub files for typing support #476

Description

@Joseph-Edwards

A lot of the source code for this package is written in C++, and therefore it is not possible to provide inline typing support. To get around this, we could provide stub files that include the typing information. This would have the following benefits:

  • Users of our package could use static type checkers like mypy with libsemigroups_pybind11.
  • We could use static type checkers whilst developing, which will likely identify some existing bugs.
  • Better tab completion (I think).
  • Sphinx can leverage information in stub files, so we may be able to get rid of some of the hacks bespoke software solutions relating to our docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    pythonPull requests that update python code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions