search

wikit-ai / olaf

6 stars 1 forks source link

Standardize the docstring of optional parameters/attributes #108

Closed ba-talibe closed 5 months ago

ba-talibe commented 5 months ago

Use the syntax `type, optional` and put the default value at the end of the parameter description by adding `, by default default_value`.

Example:

parameters : Dict[str, Any], optional
        Parameters are fixed values to be defined when building the WordNet
        external KG instance, by default None.