Skip to content

Add a private api class

Álvaro López García requested to merge add_private_api_class into master

Description

Define a base class for all models

Although when using entrypoints it is not mandatory to use classes (any importable python object can be used, in python everything is an object, so we can use modules) it is useful to define a class to document the API that we expect.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • This change is a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Merge request reports