Do not format code cells on save #2605
Merged
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
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.
We introduced the on-save formatting very early on (#40), before we had in-editor formatting (#416). We decided to drop the on-save formatting, so the code stays as written by the user and they can format using the editor as needed.
A major issue with on-save formatting is that it may introduce undesired changes for cases like Ecto queries (see #1212). We may want to export a notebook in places where we don't have an associated runtime, and so we do the formatting by calling
Code.format_string!directly. This is not ideal, because it's really the responsibility of the runtime. More importantly, we could introduce an API to respect package-specific formatting rules, but that will only work when formatting within runtime.