docs: clarify normalize usage in 5.5.0 changelog#424
Open
CoderLink06 wants to merge 6 commits intojupyter:mainfrom
Open
docs: clarify normalize usage in 5.5.0 changelog#424CoderLink06 wants to merge 6 commits intojupyter:mainfrom
CoderLink06 wants to merge 6 commits intojupyter:mainfrom
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR clarifies the wording in the 5.5.0 changelog around the
normalizefunction.The previous text caused confusion about when
normalize()should be used versusvalidate(). This change makes it clearer thatnormalize()is intended as a helper for tooling prior to validation, while most libraries should continue generating valid notebooks directly.This addresses the confusion raised in the changelog discussion.