openeduhub / metalookup

Provide metadata about domains w.r.t accessibility, licencing, adds, etc.
GNU General Public License v3.0
5 stars 0 forks source link

Where to put documentation of the individual extractors? #88

Open MRuecklCC opened 2 years ago

MRuecklCC commented 2 years ago

Currently the expected extractor behaviors are documented in German in docs/acceptance.md. This is "rather far" (actually not really) away from the implementations increasing the risk of getting out of sync. One other advantage of moving it to the class documentation would be, that we can easily expose the documentation of the individual extractors via the OpenAPI spec. Contrived oversimplified example:


from features.security import Security

@app.get(
    "/security",
   ...
    description=Security.__doc__,
)
def security(...):
   ...
MRuecklCC commented 2 years ago

Related #152