Skip to content

Better documentation on class docstring #60

@lgabs

Description

@lgabs

Comecei a usar essa lib recentemente e achei muito interessante! Andei lendo mais do código e acredito que a documentação desse parâmetro mais importante poderia melhorar. Ao invés de

group_channels = False by default.
Most important parameter on this class. This indicates the input format of the
dataframe.
True = Each row represents a user session that will be grouped into a user
journey;
False = Each row represents a user journey and the columns

poderia estar mais detalhado como no README está, talvez a mesma explicação.

Também tive um pouco de dificuldade no início para entender o nome desse parâmetro. Como ele define o formato de input do dataframe, um nome mais objetivo talvez fosse input_dataframe_format com valores como session_per_row e journey_per_row, só como exemplos de ideias.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions