Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
WDT following AJAX requests#9692
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
tomtomau left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I've left a few suggestions and flagged a few typos but otherwise looks good to me.
Thanks for teaching me something new as well!
profiler/wdt_follow_ajax.rst Outdated
| .. index:: | ||
| single: Profiling: WDT Auto-update after AJAX Request | ||
| How to make the Web Debug Toolbar Auto-upate after AJAX Requests |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
typoupdate
profiler/wdt_follow_ajax.rst Outdated
| ================================================================ | ||
| For single page applications it is often inconvenient to find the profiler | ||
| information for the most recent request. It would be much more convient if it |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
typoconvenient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Consider rephrase to:
It would be more convenient if the toolbar showed the information for the most recent AJAX request instead of the initial page load.
profiler/wdt_follow_ajax.rst Outdated
| the toolbar would show the information from the most recent AJAX request | ||
| instead of your initial page load. | ||
| By setting the `Symfony-Debug-Toolbar-Replace` to a value of `1` in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
By setting the
Symfony-Debug-Toolbar-Replaceheader to a value of1
profiler/wdt_follow_ajax.rst Outdated
| $response->headers->set('Symfony-Debug-Toolbar-Replace', 1); | ||
| Only setting the header durring development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
typoduring
profiler/wdt_follow_ajax.rst Outdated
| Only setting the header durring development | ||
| ------------------------------------------- | ||
| Ideally this header should only be set durring development and not for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
typoduring
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Perhaps:
As the Web Debug Toolbar should not be used in production, this header should only be set in the development environment. This can be accomplished by creating a
kernel.responseevent listener that is only registered in the development environment.
javiereguiluz left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
A fantastic feature and a very nice first contribution to Symfony Docs. Thanks a lot!
profiler/wdt_follow_ajax.rst Outdated
| showed the information for the most recent AJAX request instead of the | ||
| initial page load. | ||
| By setting the `Symfony-Debug-Toolbar-Replace` header to a value of `1` in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The syntax used in Symfony Docs is similar to Markdown, but different in some cases. One of those cases is the use of double backticks for code. This:
`Symfony-Debug-Toolbar-Replace`should be written like this:
``Symfony-Debug-Toolbar-Replace``Same for the1 code used in the same phrase.
profiler/wdt_follow_ajax.rst Outdated
| $response->headers->set('Symfony-Debug-Toolbar-Replace', 1); | ||
| Only setting the header during development |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
For titles we use a special "title case" where the first letter of most, but not all, words is uppercased. So, this title should be:
Only Setting the Header During Development------------------------------------------
This PR is for#8409 and the functionality insymfony/symfony#26655.
This is my first Doc PR so I'm happy for all the constrictive input there is to give. I'm really hoping this functionality can make 4.1.