Thursday, April 26, 2018

Documentation: incorrect mixing of Dev Mode and SuperDev Mode in 'Overview' article

Hello, GWT Team!

I would like to address the incorrect mixing of Dev Mode and SuperDev Mode in 'Overview' article:
"You can debug AJAX applications in your favorite IDE just like you would a desktop application, and in your favorite browser just like you would if you were coding JavaScript. The GWT developer plugin spans the gap between Java bytecode in the debugger and the browser's JavaScript.

Thanks to the GWT developer plugin, there's no compiling of code to JavaScript to view it in the browser. You can use the same edit-refresh-view cycle you're used to with JavaScript, while at the same time inspect variables, set breakpoints, and utilize all the other debugger tools available to you with Java. And because GWT's development mode is now in the browser itself, you can use tools like Firebug and Inspector as you code in Java."


It's not clear that developer can use one option or another, not both at the same time. When someones read "utilize all the other debugger tools available to you with Java", he starts thinking about his Java IDE, but then immediately he reads "And because GWT's development mode is now in the browser itself, you can use tools like Firebug and Inspector" - he becomes confused, how is that possible to set breakpoints in both Java IDE and in Firebug? The same thing about "like you would a desktop application, and in your favorite browser", instead "and" its better to say "or", and specify exactly that these are two different approaches to debug the app.

Also, which is more important, in Docs -> Coding Basics -> Compile And Debugging, entire article is dedicated to obsolete Dev Mode, and only a single sentence saying "Early adopters may wish to try out an alternative to Development Mode. See Introducing Super Dev Mode". That's very confusing for first time users of GWT, because they spend time read entire article and at the end it is revealed that this approach is obsolete and they have to consider SuperDev Mode. Moreover, Dev Mode is even disabled by default when they try any new GWT 2.8 project from scratch, so they will read the article, try it locally - and it won't give expected results.

In my opinion it's better to entirely cut off Dev Mode related phrases in these two sections and move it to a separate article for GWT users with versions <2.5. Also, Docs -> Coding Basics -> Compile And Debugging article should be entirely rewritten to include the information from "Introducing Super Dev Mode" article instead.

Thanks, Georgiy

--
You received this message because you are subscribed to the Google Groups "GWT Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to google-web-toolkit+unsubscribe@googlegroups.com.
To post to this group, send email to google-web-toolkit@googlegroups.com.
Visit this group at https://groups.google.com/group/google-web-toolkit.
For more options, visit https://groups.google.com/d/optout.

No comments:

Post a Comment