Added a information about files with/without message. #313
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miguelgrinberg
requested changes
Jan 22, 2020
docs/index.rst
Outdated
| @@ -47,8 +47,14 @@ This will add a `migrations` folder to your application. The contents of this fo | |||
|
|
|||
| You can then generate an initial migration:: | |||
|
|
|||
| $ flask db migrate | |||
|
|
|||
| $ flask db migrate #-m "You can leave optional message." | |||
There was a problem hiding this comment.
I prefer that you only show the version of this command with a message. Adding the message but commented out is confusing, since it has no effect. So please remove the # and change the message to something that is appropriate for this example, such as "Initial migration".
docs/index.rst
Outdated
| 5d3244f628be.py | ||
|
|
||
| - ``Revision script with message:`` | ||
| 5d3244f628be_you_can_leave_message_optional.py |
There was a problem hiding this comment.
This is a high-level example, showing naming examples for migration scripts does not belong, and does not really add any valuable information. Better to encourage people to always use comments by only showing that in the example above, as I suggested.
Bernardoow
force-pushed
the
adding_information_about_message
branch
from
15a46c5
to
e5c287b
Compare
Bernardoow
force-pushed
the
adding_information_about_message
branch
from
e5c287b
to
f9bd807
Compare
|
Done! |
miguelgrinberg
approved these changes
Jan 22, 2020
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added little information about optional message and how file will be create with this.