Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation on class docstring #60

Open
lgabs opened this issue Apr 14, 2022 · 0 comments
Open

Better documentation on class docstring #60

lgabs opened this issue Apr 14, 2022 · 0 comments

Comments

@lgabs
Copy link

lgabs commented Apr 14, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant