From d402d9cbf9e62b4c8e9b8ced3d67db18cfcdf923 Mon Sep 17 00:00:00 2001 From: Nikola Milovic <50072027+Nikola-Milovic@users.noreply.github.com> Date: Thu, 30 Jun 2022 00:51:42 +0200 Subject: [PATCH] fix(docs): fix command typo and duplicate (#144) * fix(docs): remove duplicate command from debug table In the Debug section Command table `GoBreakToggle` was mentioned twice, I just removed the duplicate * fix(docs): fix the BreakCondition command and formatting on some markdown tables * indentation Co-authored-by: rayx --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6fd0986bf..847158949 100644 --- a/README.md +++ b/README.md @@ -214,15 +214,15 @@ first run of `GoFmt` may fail. It is recommended to run `GoInstallBinaries` to i | GoTest -n | test nearest, see GoTestFunc | | GoTest -f | test current file, see GoTestFile | | GoTest -p | test current package, see GoTestPkg | -| GoTest -t yourtags | go test ./... -tags=yourtags, see notes | -| GoTest package_path -t yourtags | go test packagepath -tags=yourtags | -| GoTest package_path -t yourtags other_args | go test packagepath -tags=yourtags other_args | +| GoTest -t yourtags | go test ./... -tags=yourtags, see notes | +| GoTest package_path -t yourtags | go test packagepath -tags=yourtags | +| GoTest package_path -t yourtags other_args | go test packagepath -tags=yourtags other_args | | GoLint | golangci-lint | | GoGet {package_url} | go get package_url and restart gopls. Note1 | | GoVet | go vet | | GoCoverage | go test -coverprofile | | GoCoverage -f coverage_file_name | load coverage file | -| GoCoverage {flags} | -t : toggle, -r: remove signs, -R remove sings from all files, -m show metrics | +| GoCoverage {flags} | -t : toggle, -r: remove signs, -R remove sings from all files, -m show metrics| | GoTermClose | `closes the floating term` | Note: @@ -257,7 +257,7 @@ Support table based unit test auto generate, parse current function/method name GoTestXXX Arguments -| arguments | Description | +| arguments | Description | | ------------------------ | ------------------------------------------------------- | | -v | verbose mode | | -c | compile | @@ -358,7 +358,7 @@ or simply put your cursor in a struct and do | GoDebug -a | attach to remote process | | GoDebug -s | stop debug session and unmap debug keymap | | GoBreakToggle | GoDebug -b | -| GoBreakCondition | conditional break | +| BreakCondition | conditional break | ## Switch between go and test file @@ -390,15 +390,15 @@ type GoLintComplaining struct{} ``` | command | Description | | ---------------- | ------------------------------------------------------- | -| GoCmt | Add comment| +| GoCmt | Add comment | ## GoModTidy | command | Description | | ---------------- | ------------------------------------------------------- | -| GoModInit | run `go mod init` and restart gopls | -| GoModTidy | run `go mod tidy` and restart gopls | -| GoModVendor | run `go mod vendor` and restart gopls | +| GoModInit | run `go mod init` and restart gopls | +| GoModTidy | run `go mod tidy` and restart gopls | +| GoModVendor | run `go mod vendor` and restart gopls | run `go mod tidy` and restart gopls @@ -485,9 +485,8 @@ Here is a sample [launch.json](https://github.com/ray-x/go.nvim/blob/master/play | -------------- | ----------------------------------------------------------------------------------------------- | | GoDebug | Start debugger, to debug test, run `GoDebug test`, to add addition args run `GoDebug arg1 arg2` | | GoDebugConfig | Open launch.json file | -| GoBreakToggle | toggle break point | -| GoBreakSave | save all breakpoints to project file point | -| GoBreakLoad | load all breakpoints from project file point | +| GoBreakSave | save all breakpoints to project file | +| GoBreakLoad | load all breakpoints from project file | | GoBreakToggle | toggle break point | | BreakCondition | conditional break point | | ReplRun | dap repl run_last |