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

bug: Automatic column naming #19

Merged
merged 1 commit into from
Nov 8, 2022
Merged

Conversation

a-vester
Copy link
Member

@a-vester a-vester commented Nov 3, 2022

Perform review and test code base:

  1. Clone/Pull the branch: git checkout -t origin/fix_col_naming_9
  2. Activate your virtual env
  3. pip install --upgrade -e .[dev,docs,tests]
  4. pytest

  • get_scores_from_ratings()
    When input a pd.Series, the name of the output series will now become ratings.name prefixed with "rtg_score_".
    When input a pd.DataFrame, the column names of the output frame will now become ratings.columns prefixed with "rtg_score_".

    The last column name is an example from the "Getting started..." section of the documentation, where the worst_rtg column has been used as an input parameter.

image

  • get_warf_from_ratings()
    When input a pd.Series, the name of the output series will now become ratings.name prefixed with "warf_".
    When input a pd.DataFrame, the column names of the output frame will now become ratings.columns prefixed with "warf_".

    The last column name is an example from the "Getting started..." section of the documentation, where the worst_rtg column has been used as an input parameter.

image

Closes #9

BREAKING CHANGE:
* ``get_scores_from_ratings()``
  When input a ``pd.Series``, the name of the output series will now
  become ``ratings.name`` prefixed with "rtg_score".
  When input a ``pd.DataFrame``, the column names of the out frame
  will now become ``ratings.columns`` prefixed with "rtg_score_".
* ``get_warf_from_ratings()``
  When input a ``pd.Series``, the name of the output series will now
  become ``ratings.name`` prefixed with "warf".
  When input a ``pd.DataFrame``, the column names of the out frame
  will now become ``ratings.columns`` prefixed with "warf_".

Closes #9
@a-vester a-vester added the bug Something isn't working label Nov 3, 2022
Copy link
Collaborator

@deepakparashar1987 deepakparashar1987 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ran the test locally and all looks great.

@deepakparashar1987 deepakparashar1987 merged commit dc9b992 into main Nov 8, 2022
@deepakparashar1987 deepakparashar1987 deleted the fix_col_naming_9 branch November 8, 2022 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Automatic column naming could be misleading
2 participants