DP6 / DP6/Marketing-Attribution-Models
Better documentation on class docstring
- Dominant language
- Python
- Stars
- 369
- Forks
- 87
- Avg merge
- 12h 52m
- Merged PRs (30d)
- 4
Description
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
https://github.com/DP6/Marketing-Attribution-Models/blob/0b1cfd7d57a6701804cb395caacc6b2c8c72fe97/marketing_attribution_models/MAM.py#L44-L49
poderia estar mais detalhado como no [README está](https://github.com/DP6/Marketing-Attribution-Models#4-demonstration), 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.
Contributor guide
Research direction
Start with the class docstring in marketing_attribution_models/MAM.py at lines 44-49, then compare it with the explanation in README section 4, “Demonstration.” Clarify the parameter’s input format and assess the suggested parameter and value names. Done means the docstring clearly explains the accepted dataframe formats and matches the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100