Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Improve formatting and clarity of HTML Notes #790
This is related to #528.
The HTML Notes generated by Comet Cache include information about the cache file and statistical information about how long it took to generate the cache file and load it. These notes contain a lot of information, but they are currently compressed into a format that makes easily retrieving the information you're looking for unnecessarily difficult (e.g., try finding how this cache file was generated—the text that comes after "via"—or try to understand how long it took to load this cache file, vs how long it took to generate it; also note that the Page URL is listed twice here):
I propose that we improve this by making the notes more readable. You'll notice I've changed the wording a bit as well, to make certain things more clear, e.g., "This page was loaded via the cache in 0.01436 seconds" is near the top and is more clear than "Cache file served for (http://local.wordpress.dev/.../) in 0.01436 seconds".
These are HTML Notes after all, so we can be liberal with whitespace. If a site owner doesn't want the HTML Notes visible or feels that the extra whitespace adds too much to the page size, they can disable the HTML Notes in Comet Cache → Plugin Options → Enable/Disable.
We may also want to consider adding another option to the
I agree. I love the example you gave. I imagine it being tabulated like this also.
<!-- Comet Cache fully functional. :-) This page was loaded from the cache in 0.01436 seconds. --- Cache File Information and Statistics ------------------------------------------------ File path: /cache/comet-cache/cache/http/local-wordpress-dev/2016/06/13/testing-full-width-featured-image.html Page URL: http://local.wordpress.dev/2016/06/13/testing-full-width-featured-image/ Date generated: Jun 21st, 2016 @ 10:54 pm UTC Expiration date: Jun 28th, 2016 @ 10:54 pm UTC (based on your configured expiration time) Time to generate this cache file: 1.34647 seconds Generated via: Auto-Cache Engine -->
If you really (really) want to dive into this, you can read a bit here:
Comet Cache v161119 has been released and includes changes from this GitHub Issue. See the v161119 announcement for further details.
This issue will now be locked to further updates. If you have something to add related to this GitHub Issue, please open a new GitHub Issue and reference this one (#790).