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

Adjusted an example to align with the documentation section on reversing a previous migration. #50228

Conversation

cedriccarrard
Copy link
Contributor

@cedriccarrard cedriccarrard commented Dec 1, 2023

Motivation / Background

Fixes #50189.
There is an error in the following section this documentation section.

There is confusion between the steps

1. Reverse the order of create_table and reversible.
2. Replace create_table with drop_table.
3. Finally, replace up with down and vice-versa.

and the example below

I suggest modifying the example.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@rails-bot rails-bot bot added the docs label Dec 1, 2023
@cedriccarrard cedriccarrard marked this pull request as ready for review December 1, 2023 10:39
@cedriccarrard cedriccarrard changed the title fix-#50189-docs-mismatch-between-revert-code-example-and-subsequent-s… fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-s… Dec 1, 2023
@cedriccarrard cedriccarrard changed the title fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-s… Fix docs mismatch revert code example Dec 1, 2023
@cedriccarrard cedriccarrard force-pushed the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch 2 times, most recently from 1bd9778 to c70e428 Compare December 1, 2023 10:54
@cedriccarrard cedriccarrard changed the title Fix docs mismatch revert code example Adjusted an example to align with the documentation section on reversing a previous migration. Dec 1, 2023
@cedriccarrard cedriccarrard force-pushed the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch 3 times, most recently from 2f5d3f3 to 30a9bf2 Compare December 2, 2023 11:26
@Leo-U
Copy link

Leo-U commented Dec 3, 2023

Modifying the example seems like it might be ok, at least to me. But I'm thinking maybe someone removed it for a specific reason, and without knowing what that reason was, maybe simply adding back in the 'create_table' isn't the solution? Idk, what do you think?

@cedriccarrard
Copy link
Contributor Author

cedriccarrard commented Dec 4, 2023

@Leo-U I think it's just an oversight when updating the documentation, what do you think @adrianna-chang-shopify ?

@cedriccarrard cedriccarrard reopened this Dec 15, 2023
@cedriccarrard cedriccarrard force-pushed the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch from 30a9bf2 to 12ecdc4 Compare January 25, 2024 09:39
@cedriccarrard cedriccarrard force-pushed the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch from 12ecdc4 to da69536 Compare January 25, 2024 10:43
@cedriccarrard cedriccarrard force-pushed the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch from da69536 to 992dbd7 Compare May 22, 2024 19:09
@rafaelfranca rafaelfranca merged commit 6a283ac into rails:main May 22, 2024
1 of 3 checks passed
rafaelfranca added a commit that referenced this pull request May 22, 2024
…between-revert-code-example-and-subsequent-steps

Adjusted an example to align with the documentation section on reversing a previous migration.
@cedriccarrard cedriccarrard deleted the fix-50189-docs-mismatch-between-revert-code-example-and-subsequent-steps branch August 22, 2024 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistency in Documentation: Mismatch Between revert Code Example and Subsequent Steps
3 participants