Improve the VS Code Debugging Page with Relevant Links#968
Improve the VS Code Debugging Page with Relevant Links#968Daltz333 merged 6 commits intowpilibsuite:masterfrom
Conversation
|
Some structure questions I have:
|
|
I would keep the note that a debugger is recommended. We shouldn't recommend prints. An accidental print in Java robot code can cause some pretty severe loop overruns |
|
are you talking about the note in the blue box? It felt repetitive with what I had under Debugging with Print Statements. I have no problem adding it back if that is what you meant as it is an important point to ram home |
|
Who knows the most about OutlineViewer? There are some featuers I am unsure what they do and I have never actually used it. Is it okay to leave the addition of OutlineViewer in this PR? |
source/docs/software/vscode-overview/debugging-robot-program.rst
Outdated
Show resolved
Hide resolved
|
The OutlineViewer should be a seperate article. And yeah, I'd leave the note. People don't like to read things that aren't loud at them. |
|
Ideally, I'd like to refactor this page a bit more. New DirectivesCan we use the directive for keyboard shortcuts and migrate to inline image tags IE: Replace with Additionally, things like GUI text elements should be highlighted with the Order of OperationsThe order of heading structure is TOCI'd like to see the debugging page a bit lower on the TOC of vscode-overview. |
|
With :kdb: should it be Ctrl or Control? No spaces? + or -? I am going to clean up other similar issues. |
|
Control is Mac, Ctrl is Windows/Linux. I would just use Ctrl, as Mac users know the interop. |
|
What about spaces and +/-? I wasn't familiar with :kdb: should we add that to the style doc? |
|
What do you think TOC should be? I like moving 3rd party up to after creating and before deploying (because you need to know to have them before you deploy). I am not sure what else I would move above debugging both of the importing only needs to be done once so it should either go to the top or where it is and using test mode I think is in the wrong section. It should probably go to the driverstation section or something. It really has nothing to do with VS Code Overview |
Closes #355