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

remove use_index and references to it in get_records #1343

Merged
merged 3 commits into from
Nov 6, 2023

Conversation

alifeee
Copy link
Collaborator

@alifeee alifeee commented Nov 5, 2023

closes #1332

use_index was added by #1301 to make implementing #808 easier in future

we can add it back later when the column-indexing functionality is added

@alifeee alifeee linked an issue Nov 5, 2023 that may be closed by this pull request
@alifeee alifeee added this to the 5.12.1 milestone Nov 5, 2023
@alifeee alifeee self-assigned this Nov 5, 2023
Copy link
Collaborator

@lavigne958 lavigne958 left a comment

Choose a reason for hiding this comment

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

Wait I just thought of something, what if someone used it currently with the value 0? I suppose it would break their code the remove the argument 🤦‍♂️

Like if someone has the following code:

sh.get_record(use_index=0)

This works fine and of we removed it some users won't understand 😑

We need to add a new warning then we introduce the removal in the next version, again unless we leave it if it's easier. Now to me it seems it's more work to remove it than keep it 😒

@alifeee
Copy link
Collaborator Author

alifeee commented Nov 5, 2023

you raise a good point. This PR now deprecates use_index, and #1345 removes it (from 6.0.0). I do not think this is a big enough change requiring an entry in the migration guide (since get_records was only added a few weeks ago)

@lavigne958
Copy link
Collaborator

you raise a good point. This PR now deprecates use_index, and #1345 removes it (from 6.0.0). I do not think this is a big enough change requiring an entry in the migration guide (since get_records was only added a few weeks ago)

great changes thanks !

@alifeee alifeee merged commit 67759c7 into master Nov 6, 2023
12 checks passed
@alifeee alifeee deleted the 1332-remove-unused-parameter-or-use-it branch November 6, 2023 22:37
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

Successfully merging this pull request may close these issues.

Remove unused parameter or use it
2 participants