Improve docs on setup #60
Merged
Conversation
This file contains hidden or 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
The previous wording wasn't clear that the package wouldn't work correctly without it
This initialization is mandatory and is better placed at the top of the file, before optional explainations
Owner
|
Many Thanks! I hope now it will be clearer to users. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I spent a lot of time the last two days trying to understand why the tree was not updated correctly after flush, before finding and understanding the paragraph on the
mptt_sessionmaker. I changed the docs to make it clearer that this step is mandatory. I also struggled to find out where to apply this wrapper, because we use flask_sqlalchemy for integration with our flask backend, and the Session creation is hidden. So I add also instructions on how to applymptt_sessionmakerin that case.