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.

Sign up for GitHub

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

Jump to bottom

Make the batch parameter a bit more obvious #87

Merged
merged 2 commits into from
Feb 22, 2023
Merged

Make the batch parameter a bit more obvious #87

merged 2 commits into from
Feb 22, 2023

Conversation

3kyro
Copy link
Contributor

@3kyro 3kyro commented Feb 16, 2023

Make the batch size parameter a bit more obvious in the documentation of ModifyColumnMigration

@3kyro 3kyro requested a review from jsynacek February 16, 2023 16:24
@3kyro 3kyro requested a review from zlondrej February 16, 2023 16:26
jsynacek
jsynacek reviewed Feb 20, 2023
View reviewed changes
Copy link
Contributor

@jsynacek jsynacek left a comment

Choose a reason for hiding this comment

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

Otherwise, I don't really feel like your change makes the docs any more clear. What seems to be the most helpful improvement is improving the statement about that it runs in batches.
@arybczak Might want to decide this.

src/Database/PostgreSQL/PQTypes/Model/Migration.hs Outdated
--
-- Function that takes a list of primary keys provided by the cursor SQL and
-- Modification function that takes a batch of primary keys provided by the cursor SQL and
Copy link
Contributor

Choose a reason for hiding this comment

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

Why would you point out that this function is a Modification function? It's called ModifyColumnMigration and the docs also say that it runs an arbitrary computation... To me, stating that this function modifies something is quite excessive and makes the doc a bit annoying to read.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍🏽 sure it does look annoying now. I'll remove Modification

@3kyro
Copy link
Contributor Author

3kyro commented Feb 20, 2023

Otherwise, I don't really feel like your change makes the docs any more clear. What seems to be the most helpful improvement is improving the statement about that it runs in batches. @arybczak Might want to decide this.

Clarifying that it runs in batches was the reason for this PR as it came up during a review where it wasn't clear to me.

jsynacek
jsynacek approved these changes Feb 21, 2023
View reviewed changes
Copy link
Contributor

@jsynacek jsynacek left a comment

Choose a reason for hiding this comment

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

Ok, this looks much better to me.

@3kyro 3kyro merged commit b30859c into master Feb 22, 2023
@3kyro 3kyro deleted the document-batch-size branch February 22, 2023 08:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsynacek jsynacek jsynacek approved these changes

@zlondrej zlondrej Awaiting requested review from zlondrej

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@3kyro @jsynacek