[GitHub] [singa-doc] FeynmanDNA commented on a change in pull request #5: Update some documentation files

[GitBox <gi...@apache.org>]

FeynmanDNA commented on a change in pull request #5: Update some documentation files
URL: https://github.com/apache/singa-doc/pull/5#discussion_r396099285
 
 

 ##########
 File path: docs-site/docs/contribute-code.md
 ##########
 @@ -18,120 +18,70 @@ A simple way to enforce the Google coding styles is to use the linting and forma
 
 Once the extensions are installed, edit the `settings.json` file.
 
-```json 
+```json
 {
-   "[cpp]": {
-      "editor.defaultFormatter": "xaver.clang-format"
-   },
-   "cpplint.cpplintPath": "path/to/cpplint",
-
-   "editor.formatOnSave": true,
-   "python.formatting.provider": "yapf",
-   "python.linting.enabled": true,
-   "python.linting.lintOnSave": true,
-   "clang-format.language.cpp.style": "google",
-   "python.formatting.yapfArgs" : ["--style" , "{based_on_style: google}" ]
+  "[cpp]": {
+    "editor.defaultFormatter": "xaver.clang-format"
+  },
+  "cpplint.cpplintPath": "path/to/cpplint",
+
+  "editor.formatOnSave": true,
+  "python.formatting.provider": "yapf",
+  "python.linting.enabled": true,
+  "python.linting.lintOnSave": true,
+  "clang-format.language.cpp.style": "google",
+  "python.formatting.yapfArgs": ["--style", "{based_on_style: google}"]
 }
 ```
 
 Depending on your platform, the user settings file is located here:
+
 1. Windows %APPDATA%\Code\User\settings.json
-2. macOS $HOME/Library/Application Support/Code/User/settings.json
-3. Linux $HOME/.config/Code/User/settings.json
+2. macOS \$HOME/Library/Application Support/Code/User/settings.json
 
 Review comment:
   probably this is due to the linting and formatting, maybe you can try wrap these paths in ticks
   
   2. macOS `$HOME/Library/Application Support/Code/User/settings.json`
   3. Linux `$HOME/.config/Code/User/settings.json`

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services