Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up README and TODO comments. #1592

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Clean up README and TODO comments. #1592

merged 2 commits into from
Nov 1, 2024

Commits on Oct 31, 2024

  1. Clean up README and TODO comments. 

    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.
    @munificent
    munificent committed Oct 31, 2024
    Configuration menu
    Copy the full SHA
    c327b36 View commit details
    Browse the repository at this point in the history

  2. Rename example file.

    @munificent
    munificent committed Oct 31, 2024
    Configuration menu
    Copy the full SHA
    3d0ee44 View commit details
    Browse the repository at this point in the history