changepoints: type hints

The docstrings to flagChangePoints seems to be broken, could you please check that @luenensc ?

I renamed some parameters, as parameters with leading underscore seem weird to me.

changed milestone to %Merge 1.5

added category: algorithms + 1 deleted label

added 1 commit

• 87793b64 - Literal is Python3.8 and needs to be imported from typing_extensions

Compare with previous version

added 1 commit

• b55e847e - added typing_extensions to changepoints

Compare with previous version

added 1 commit

• 52b9466b - Update requirements.txt

Compare with previous version

changed title from Added typehints, renamed arguments to Changepoints: type hints

changed title from Changepoints: type hints to changepoints: type hints

removed 1 deleted label

mentioned in issue #138 (closed)

hm... i like those leading underscores.

i kind of wanted to mark those parameters with leading underscore as "private" - they are only used by other functions, when they wrap around them and are not meant to be used by the user directly. Also i thought, that way, one can easily exclude them from the read the docs docu.

I think i have seen leading underscore parameter in pandas functions. But maybe my mind tricks me. so.. couldnt we keep those or is it really too weird?

Sure we could... But I can't see anything private in a function parameter, because, a signature is public contract. The docs arguments is sort of compelling though...

Maybe @palmb has an opinion on that?

added 1 commit

• 4f6dfea3 - docstring repaired

Compare with previous version

approved this merge request

assigned to @schaefed and unassigned @luenensc

resolved all threads

merged

mentioned in commit cb12c41e

resolved all threads