Skip to content

Conversation

@jasondaming
Copy link
Member

Closes #355

@jasondaming
Copy link
Member Author

Some structure questions I have:

@Daltz333
Copy link
Member

Daltz333 commented Dec 3, 2020

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

@jasondaming
Copy link
Member Author

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

@jasondaming
Copy link
Member Author

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?

@Daltz333
Copy link
Member

Daltz333 commented Dec 3, 2020

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.

@jasondaming jasondaming marked this pull request as ready for review December 3, 2020 20:35
@Daltz333
Copy link
Member

Daltz333 commented Dec 4, 2020

Ideally, I'd like to refactor this page a bit more.

New Directives

Can we use the

:kbd:`Ctrl+Shift+P`

directive for keyboard shortcuts and migrate to inline image tags

IE: Replace

| my image |

with

.. image:: myimage.png
   :alt: What my image shows

Additionally, things like GUI text elements should be highlighted with the guilabel directive

:guilabel:`my label`

Order of Operations

The order of heading structure is =, -, ^, ~. This page currently uses =, -, ~, ^. In reality, it's trivial but it's nice to stay consistent.

TOC

I'd like to see the debugging page a bit lower on the TOC of vscode-overview.

@jasondaming
Copy link
Member Author

With :kdb: should it be Ctrl or Control? No spaces? + or -? I am going to clean up other similar issues.

@Daltz333
Copy link
Member

Daltz333 commented Dec 4, 2020

Control is Mac, Ctrl is Windows/Linux. I would just use Ctrl, as Mac users know the interop.

@jasondaming
Copy link
Member Author

What about spaces and +/-? I wasn't familiar with :kdb: should we add that to the style doc?

@jasondaming
Copy link
Member Author

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

@Daltz333 Daltz333 merged commit 52ec239 into wpilibsuite:master Dec 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve debugging page

4 participants