docs: add documentation on how to debug embedded app in linux using vscode#1574
docs: add documentation on how to debug embedded app in linux using vscode#1574dipinknair wants to merge 7 commits intomainfrom
Conversation
github-actions
bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1574 +/- ##
==========================================
+ Coverage 80.28% 80.30% +0.01%
==========================================
Files 42 42
Lines 3191 3193 +2
==========================================
+ Hits 2562 2564 +2
Misses 629 629 🚀 New features to boost your workflow:
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Coverage variation | ✅ +0.01% coverage variation (-1.00%) |
| Diff coverage | ✅ ∅ diff coverage |
Coverage variation details
Coverable lines Covered lines Coverage Common ancestor commit (6607e79) 3191 2562 80.29% Head commit (9bcdd28) 3193 (+2) 2564 (+2) 80.30% (+0.01%) Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch:
<coverage of head commit> - <coverage of common ancestor commit>
Diff coverage details
Coverable lines Covered lines Diff coverage Pull request (#1574) 0 0 ∅ (not applicable) Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified:
<covered lines added or modified>/<coverable lines added or modified> * 100%
TIP This summary will be updated as you push new changes. Give us feedback
|
Pull request documentation preview limit (10) reached: skipping documentation deployment for this pull request. |
| ] | ||
| } | ||
|
|
||
| #. Start **Run and Debug**, choose **Python Debugger: Current File**, and run your script. |
There was a problem hiding this comment.
Bold is used only to indicate UI options--is that the case here?
| Debugging with Visual Studio Code | ||
| --------------------------------- | ||
|
|
||
| To debug embedded PyMechanical scripts in VS Code on Linux, export the environment that |
There was a problem hiding this comment.
| To debug embedded PyMechanical scripts in VS Code on Linux, export the environment that | |
| To debug embedded PyMechanical scripts in Visual Studio Code on Linux, export the environment that |
| --------------------------------- | ||
|
|
||
| To debug embedded PyMechanical scripts in VS Code on Linux, export the environment that | ||
| ``mechanical-env`` would set and attach the debugger to it. See |
There was a problem hiding this comment.
| ``mechanical-env`` would set and attach the debugger to it. See | |
| ``mechanical-env`` variable would set and attach the debugger to it. See |
There was a problem hiding this comment.
maybe "mechanical-env script" instead
There was a problem hiding this comment.
@klmcadams I was just trying to put a noun after to indicate what type of entity it was. Script is fine with me. I do think I made the same "variable" change elsewhere though so I'd recommend a search. (I can make to see that you found that edit of mine and also recommended script there. Way to go!)
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
| Debug with Visual Studio Code on Linux | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| On Linux, the Python debugger must see the same environment that ``mechanical-env`` sets when |
There was a problem hiding this comment.
| On Linux, the Python debugger must see the same environment that ``mechanical-env`` sets when |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| On Linux, the Python debugger must see the same environment that ``mechanical-env`` sets when | ||
| On Linux, the Python debugger must see the same environment that the ``mechanical-env`` variable sets when |
There was a problem hiding this comment.
| On Linux, the Python debugger must see the same environment that the ``mechanical-env`` variable sets when | |
| On Linux, the Python debugger must see the same environment that the ``mechanical-env`` script sets when |
| --------------------------------- | ||
|
|
||
| To debug embedded PyMechanical scripts in VS Code on Linux, export the environment that | ||
| ``mechanical-env`` would set and attach the debugger to it. See |
There was a problem hiding this comment.
maybe "mechanical-env script" instead
4 participants
Closes #1190