Always float comments to the top of field values #87
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.
Fixes #70.
Previously Gild would only float comments to the top of a field if Gild knew how to parse the field (like
build-depends
) and the field parsed successfully. Otherwise Gild would leave the comments where they were (although it would re-indent them). Now Gild will always pull all comments up to the top of a field, regardless of if Gild knows how to parse the field or if the parsing succeeded.This is a change in behavior. Hopefully it's easier for users to understand how Gild behaves.
Before:
After:
In the future, it's possible that Gild will make an effort to keep comments where they were. However in general this is a difficult problem and in some cases it doesn't have a clear answer. So for now this predictable behavior is preferable.