make explanations a bit more accessible and clear and improve grammar… #1424
Conversation
… with regards to the basics of route handling
lib/Dancer2/Manual.pod
Outdated
|
|
||
| =item * | ||
|
|
||
| a script to start your appliaction in L<bin>. |
There was a problem hiding this comment.
Application is misspelled here.
| When defining a route handler for the GET method, Dancer2 automatically | ||
| defines a route handler for the HEAD method (in order to honour HEAD | ||
| requests for each of your GET route handlers). | ||
| When defining GET route hander, Dancer2 also automatically |
There was a problem hiding this comment.
Handler is misspelled here.
|
Good work! Minor changes. See my notes in the commits. |
|
I like the changes and can use them with a little more tweaking. I would be remiss in not saying that we have a new documentation branch in the works that throws out much of this manual, so if we merge this, it will not be around for the long haul. I am grateful for the effort you have put here. Thank you! |
fix misspelling of simple
|
Thanks. 👍 from me. Fellow Dancers? |
|
hey, wanted to handle this part of documentation. |
|
While this can be merged as-is, it is orthogonal to the rewritten documentation available in #1069 which I am now reviewing, refreshing, and updating. The plan is for the new documentation to entirely replace this and much of the changes described here are written differently in the new docs - while attempting to convey the same approachability. I know this is fairly late in the process (better late than never?) but it would be best to review and apply such improvements to the new documentation. Unfortunately, it is not complete yet. However(!), there is now a clear plan and I'm making steady progress. @sdondley would you be interested in helping review the new documentation once it is ready with the same ideas you had with these changes? You might have similar things to improve. I would greatly appreciate it. |
|
Well, it's been a while since I've played with with Dancer2 but I can review it when finished and see if there are any confusing parts from the perspective of a new user. |
… and formatting
Just some fairly minor tweaks to the the first couple hundred lines of Manual.pod to improve clarity.