Clean up README and TODO comments. #1592
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
Updated the example in the README to one that uses the new style. I also took the opportunity to find a more interesting example and generally rewrote things based on how the formatter is used today. When we were in the middle of the rewrite, I used "TODO(tall)" and "TODO(perf)" comments to track things I wanted to look into before I considered the rewrite "done". Now that the rewrite is basically good enough, I went through those. If I think the TODO is no longer worth doing at all, I just deleted it. Otherwise, I turned it into a general "TODO(rnystrom)" for us to keep in mind at some unspecified time.
natebosch
approved these changes
Oct 31, 2024
kallentu
approved these changes
Oct 31, 2024
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.
Updated the example in the README to one that uses the new style. I also took the opportunity to find a more interesting example and generally rewrote things based on how the formatter is used today.
When we were in the middle of the rewrite, I used "TODO(tall)" and "TODO(perf)" comments to track things I wanted to look into before I considered the rewrite "done". Now that the rewrite is basically good enough, I went through those. If I think the TODO is no longer worth doing at all, I just deleted it. Otherwise, I turned it into a general "TODO(rnystrom)" for us to keep in mind at some unspecified time.