Closed daryadedik closed 7 years ago
Looks great, but that's exactly the problem with this kind of documentation: it changes a lot (styles, formatting, etc.) after small changes.
In the future we have to think of a better alternative.
AFAIK, in R there is an automated documentation file generation process, you don't need to do formatting you just change fields (name of function, what it does, what parameters it accepts) and create examples and build it (very similar to latex format). Don't know whether there is something like that in Python.
That's the documentation generated by Sphinx we had in the /docs folder. It can read doc strings and build an api doc, but we are not using it. We should definitely plan for a ticket to have better documentations (not the quick fix we have right now).
and for the current PR, I have two quick comments:
metadata
, I actually meant removing only baseline_variant
(and keep the others as optional, maybe only experiment
as mandatory) because in the example we have more:
{'experiment': 'random_data_generation',
'primary_KPI': 'normal_shifted',
'source': 'simulated'}
@shansfolder sure, will do the changes.
Updated .ipynb and generated new .html file.