Questions about frc-docs #4345
-
In frc-docs, it says that tabs are replaced with spaces, and the space indentation is set to 3. However, l wonder why the identation should be set to 3? l edit rst files in my vscode and the default tab represents a space indentation of 4, but l don't find any error with my docs(which is also built with sphinx and uses restructuredText). So, l wonder why the space identation should be set to 3? Besides, l don't think Notepad++ is a good tool to edit rst files since the whole project is built with sphinx and a powershell or commandline is a must to debug. However, Notepad++ doesn't seem to have a powershell or commandline tool integrated. l don't know which tool the WPILIB uses to write rst and debug the whole project. But l think vscode should be a better choice since it also has the wordwrap function and an option to change the tab's space identation to 3. Best |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 1 reply
-
Any editor will do. I usually use vscode web. Having an integrated terminal via an external one is just personal preference. The indentation is 3 spaces because it looks the best in the editor, that's all. The prefix for specifying directives is 3 characters long so nested directives line up nicely. |
Beta Was this translation helpful? Give feedback.
-
I use VS Code and an external terminal to build. I used to write with just nano before there was good rST extensions. |
Beta Was this translation helpful? Give feedback.
Any editor will do. I usually use vscode web. Having an integrated terminal via an external one is just personal preference.
The indentation is 3 spaces because it looks the best in the editor, that's all. The prefix for specifying directives is 3 characters long so nested directives line up nicely.