Skip to content

Commit 7c423eb

Browse files
sqsSourcegraphGithub Actions
authored
Fix GitHub/GitLab brand capitalization (#266)
* docs: fix GitHub and GitLab brand capitalization * [docgen] Update doc/sg.txt skip-checks: true --------- Co-authored-by: Sourcegraph <batch-changes@sourcegraph.com> Co-authored-by: Github Actions <actions@github>
1 parent 76c97d9 commit 7c423eb

File tree

2 files changed

+9
-28
lines changed

2 files changed

+9
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Requires:
3939
- nvim 0.9 or nvim nightly
4040
- Node.js >= 18.17.0 (LTS) at runtime for [`cody-agent.js`](https://github.com/sourcegraph/cody)
4141

42-
(By default, sg.nvim downloads released binaries from Github. If you prefer to build the plugin yourself, you'll need `cargo` to build)
42+
(By default, sg.nvim downloads released binaries from GitHub. If you prefer to build the plugin yourself, you'll need `cargo` to build)
4343

4444
- Currently uses plenary.nvim and telescope.nvim for some features.
4545
- If you would like to use something else for search functionality, please make an issue and I can look into adding support.

doc/sg.txt

Lines changed: 8 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ M.setup({opts}) *M.setup()*
2424

2525

2626
Parameters: ~
27-
{opts} (sg.config)
27+
{opts} (sg) .config
2828

2929

3030

@@ -136,22 +136,14 @@ Default commands for interacting with Cody
136136
:CodyAsk ~
137137
Ask a question about the current selection.
138138

139-
Use from visual mode to pass the current selection
140-
141139
*:CodyExplain*
142140
:CodyExplain ~
143141
Ask a question about the current selection.
144142

145-
Use from visual mode to pass the current selection
146-
147143
*:CodyChat{!}*
148144
:CodyChat{!} {title} ~
149145
State a new cody chat, with an optional {title}
150146

151-
If {!} is passed, will reset the chat and start a new chat conversation.
152-
153-
For more configuation options, see: `:help sg.cody.commands.chat`
154-
155147
*:CodyToggle*
156148
:CodyToggle ~
157149
Toggles the current Cody Chat window.
@@ -164,16 +156,14 @@ Default commands for interacting with Cody
164156
:CodyRestart ~
165157
Restarts Cody and Sourcegraph, clearing all state.
166158

167-
Useful if you've re-authenticated or are testing your config
168-
169159

170160

171161
M.setup({config}) *cody.setup()*
172162
Setup Cody
173163

174164

175165
Parameters: ~
176-
{config} (sg.config)
166+
{config} (sg) .config
177167

178168

179169

@@ -189,15 +179,15 @@ commands.ask_range({bufnr}, {start_row}, {end_row}, {message}, {opts}) *sg.cody.
189179
{start_row} (number)
190180
{end_row} (number)
191181
{message} (string)
192-
{opts} (cody.ChatOpts)
182+
{opts} (cody) .ChatOpts
193183

194184

195185
commands.autocomplete({request}, {callback}) *sg.cody.commands.autocomplete()*
196186
Send an autocomplete request
197187

198188

199189
Parameters: ~
200-
{request} ({ filename: string, row: number, col: number }?)
190+
{request} ({ filename: string, row: number, col: number }) ?
201191
{callback} (function(err: table, data: CodyAutocompleteResult))
202192

203193

@@ -234,7 +224,7 @@ commands.chat({new}, {opts}) *sg.cody.commands.chat()*
234224

235225
Parameters: ~
236226
{new} (boolean)
237-
{opts} (cody.ChatOpts)
227+
{opts} (cody) .ChatOpts
238228

239229

240230
commands.toggle() *sg.cody.commands.toggle()*
@@ -290,14 +280,7 @@ Default commands for interacting with Sourcegraph
290280

291281
*:SourcegraphLogin*
292282
:SourcegraphLogin ~
293-
Get prompted for endpoint and access_token if you don't want to set them
294-
via environment variables.
295-
296-
For enterprise instances, the only currently supported method is
297-
environment variables.
298-
299-
If you want to force a particular endpoint + access token combination to be
300-
saved, use :SourcegraphLogin! and then follow the prompts.
283+
Get prompted for endpoint and access_token if you don't
301284

302285
*:SourcegraphClear*
303286
:SourcegraphClear ~
@@ -311,13 +294,11 @@ Default commands for interacting with Sourcegraph
311294
*:SourcegraphDownloadBinaries*
312295
:SourcegraphDownloadBinaries ~
313296
(Re-)Download the sourcegraph binaries. This should happen during
314-
installation but you can force redownloading the binaries this way to
315-
ensure that sg.nvim is properly installed.
297+
installation
316298

317299
*:SourcegraphLink*
318300
:SourcegraphLink ~
319-
Get a sourcegraph link to the current repo + file + line. Automatically
320-
adds it to your '+' register
301+
Get a sourcegraph link to the current repo + file + line.
321302

322303
*:SourcegraphSearch*
323304
:SourcegraphSearch ~

0 commit comments

Comments
 (0)