Update to debugger documentation for 4.x #118
Conversation
Kwestor
force-pushed
the
update-debugger-docs
branch
3 times, most recently
from
3d085ed
to
f6397cf
Compare
|
You can add further commits to this PR, no need to split them up in multiple PRs. |
|
|
||
| *may not be exhaustive or up-to-date, not really ordered* | ||
| Further improvements and unsupported features |
There was a problem hiding this comment.
I don't think we should have this section at all. If there is a problem, the ticket tracker should keep it.
|
Ok, I'll add all docs change into this PR. |
Kwestor
force-pushed
the
update-debugger-docs
branch
2 times, most recently
from
e2c5fdc
to
9667f3d
Compare
| Hot code replace |new| (since 4.1) | ||
| ---------------------------------- | ||
|
|
||
| Hot code replace adds the possibility to modify and re-compile code in a debug mode and to have these changes visible |
There was a problem hiding this comment.
Are these new lines in the middle of sentences needed (maybe some formatting requirements)? Or do we have them e.g. because they were in the description of a commit/PR?
I'm just asking. :)
There was a problem hiding this comment.
Just breaking lines at ~120 character mark.
Kwestor
force-pushed
the
update-debugger-docs
branch
4 times, most recently
from
02541d4
to
8fe4e14
Compare
|
User docs for expression evaluator added. @sschaef @dragos @wpopielarski, could you please take a look? |
| from breakpoint and (possibly) modification of state of your application. | ||
|
|
||
| .. image:: images/expression-evaluator/expression.png | ||
| :alt: Sample expression evaluation |
There was a problem hiding this comment.
Some of these images look bad when they are rendered, they are too wide. Add :width: 100% as a tag to inline them into the layout.
Kwestor
force-pushed
the
update-debugger-docs
branch
from
8fe4e14
to
907a338
Compare
|
Updated. |
`expression` plug-in added in multiple places in docs. Out-of-date information removed. Further improvements description tidied up and updated (to my best knowledge). Placeholders for drop to frame, expression evaluator and HCR added.
Now it should be clearer how they work and what to expect.
Kwestor
force-pushed
the
update-debugger-docs
branch
from
f1abe6e
to
37ebf87
Compare
|
Improvements by @mpociecha added. |
|
LGTM |
Update to debugger documentation for 4.x
Out-of-date information removed.
Further improvements description tidied up and updated (to my best
knowledge).
Placeholders for drop to frame, expression evaluator and HCR added.
@sschaef @dragos if you could look especially on
Further improvements and unsupported featuressection, maybe some more things should be removed from there.TODOs:
Disclaimer required by the lawyers:
THE FOLLOWING DISCLAIMER APPLIES TO ALL SOFTWARE CODE AND OTHER MATERIALS CONTRIBUTED IN CONNECTION WITH THIS SOFTWARE:
THIS SOFTWARE IS LICENSED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY OF NON-INFRINGEMENT, ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE MAY BE REDISTRIBUTED TO OTHERS ONLY BY EFFECTIVELY USING THIS OR ANOTHER EQUIVALENT DISCLAIMER IN ADDITION TO ANY OTHER REQUIRED LICENSE TERMS.
ONLY THE SOFTWARE CODE AND OTHER MATERIALS CONTRIBUTED IN CONNECTION WITH THIS SOFTWARE, IF ANY, THAT ARE ATTACHED TO (OR OTHERWISE ACCOMPANY) THIS SUBMISSION (AND ORDINARY COURSE CONTRIBUTIONS OF FUTURES PATCHES THERETO) ARE TO BE CONSIDERED A CONTRIBUTION. NO OTHER SOFTWARE CODE OR MATERIALS ARE A CONTRIBUTION.