Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use minimal style for GoDoc popup windows in Neovim #2512

Merged
merged 1 commit into from
Sep 27, 2019
Merged

Use minimal style for GoDoc popup windows in Neovim #2512

merged 1 commit into from
Sep 27, 2019

Conversation

delphinus
Copy link
Contributor

@delphinus delphinus commented Sep 25, 2019 •
edited
Loading

This patch uses “minimal” style for floating windows to introduce more readability on :GoDoc.

See :h nvim_open_win().
See #2451 (comment)

bhcleek
bhcleek previously approved these changes Sep 26, 2019
View reviewed changes
@bhcleek bhcleek dismissed their stale review September 26, 2019 00:41

jumped the gun

@bhcleek
Copy link
Collaborator

bhcleek commented Sep 26, 2019

It sounds like style was introduced sometime after nvim_open_win. If that's the case, then this won't work for all the versions of Neovim that vim-go users may be running.

@delphinus
Copy link
Contributor Author

delphinus commented Sep 26, 2019 •
edited
Loading

@bhcleek Neovim v0.4.0 introduced style: minimal at the same time as nvim_open_win() itself (link to v0.4.0 code). The code in #2451 was written before developers in Neovim decided the final spec of nvim_open_win().

So when they come across errors for this PR, it means they are using development versions of Neovim. We should write the code for the released spec, not for its development version, I think.

@bhcleek
Copy link
Collaborator

bhcleek commented Sep 26, 2019

Thanks for the clarification on the timing of the introduction of minimal and nvim_open_win. It sound like it makes setlocal nonumber norelativenumber redundant, though. Am I reading that right?

@delphinus
Copy link
Contributor Author

delphinus commented Sep 26, 2019 •
edited
Loading

Yes. In addition to them, style: minimal has more meanings. (I noticed this I saw the chars by set list in :GoDoc popup.)

                              •  `style` : Configure the appearance of the window.
                                Currently only takes one non-empty value:
                                • "minimal" Nvim will display the window with
                                  many UI options disabled. This is useful
                                  when displaying a temporary float where the
                                  text should not be edited. Disables
                                  'number', 'relativenumber', 'cursorline',
                                  'cursorcolumn', 'foldcolumn', 'spell' and
                                  'list' options. 'signcolumn' is changed to
                                  `auto` . The end-of-buffer region is hidden
                                  by setting `eob` flag of 'fillchars' to a
                                  space char, and clearing the |EndOfBuffer|
                                  region in 'winhighlight'.

@bhcleek
Copy link
Collaborator

bhcleek commented Sep 26, 2019

In that case, can you remove the additions to the setlocal line that you added?

@delphinus
Copy link
Contributor Author

I myself did not add it. setlocal nomodified nomodifiable derives from #2451.

These two settings are effective even with style: minimal and are not necessary. But they are useful to avoid unintended behaviors, don't you think?

@bhcleek
Copy link
Collaborator

bhcleek commented Sep 27, 2019

Weird. It's showing up as an addition in this PR. 🤷‍♂ oh well. I'll merge this soon.

@bhcleek bhcleek merged commit 961d87a into fatih:master Sep 27, 2019
@bhcleek bhcleek added this to the vim-go 1.22 milestone Sep 27, 2019
bhcleek added a commit that referenced this pull request Sep 27, 2019
@bhcleek
update CHANGELOG.md for #2512 and #2516
a7b5edc
@delphinus delphinus deleted the feature/use-minimal-style-for-godoc branch September 27, 2019 03:47
clrpackages pushed a commit to clearlinux-pkgs/vim-go that referenced this pull request Feb 1, 2020
@phmccarty
Bump to 1.22 release
dec24db 
v1.22 - (January 30, 2020)

BACKWARDS INCOMPATIBILITIES:
* Drop support for Vim 7.4. The minimum required version of Vim is now 8.0.1453.
  [[GH-2495]](fatih/vim-go#2495)
  [[GH-2497]](fatih/vim-go#2497)
* Drop support for `gometalinter`
  [[GH-2494]](fatih/vim-go#2494)

IMPROVEMENTS:
* Highlight the `go` keyword in go.mod files.
  [[GH-2473]](fatih/vim-go#2473)
* Use echo functions consistently.
  [[GH-2458]](fatih/vim-go#2458)
* Add support for managing goroutines in debugger.
  [[GH-2463]](fatih/vim-go#2463)
  [[GH-2527]](fatih/vim-go#2527)
* Document `g:go_doc_popup_window`.
  [[GH-2506]](fatih/vim-go#2506)
* Make `g:go_doc_popup_window=1` work for Neovim, too.
  [[GH-2451]](fatih/vim-go#2451)
  [[GH-2512]](fatih/vim-go#2512)
* Handle errors jumping to a definition in a file open in another Vim process
  better.
  [[GH-2518]](fatih/vim-go#2518)
* Improve the UX when the gopls binary is missing.
  [[GH-2522]](fatih/vim-go#2522)
* Use gopls instead of guru for `:GoSameIds`.
  [[GH-2519]](fatih/vim-go#2519)
* Use gopls instead of guru for `:GoReferrers`.
  [[GH-2535]](fatih/vim-go#2535)
* Update documentation for `g:go_addtags_transform`.
  [[GH-2541]](fatih/vim-go#2541)
* Install most helper tools in module aware mode.
  [[GH-2545]](fatih/vim-go#2545)
* Add a new option, `g:go_referrers_mode` to allow the user to choose whether
  to use gopls or guru for finding references.
  [[GH-2566]](fatih/vim-go#2566)
* Add options to control how gopls responds to completion requests.
  [[GH-2567]](fatih/vim-go#2567)
  [[GH-2568]](fatih/vim-go#2568)
* Add syntax highlighting for binary literals.
  [[GH-2557]](fatih/vim-go#2557)
* Improve highlighting of invalid numeric literals.
  [[GH-2571]](fatih/vim-go#2571)
  [[GH-2587]](fatih/vim-go#2587)
  [[GH-2589]](fatih/vim-go#2589)
  [[GH-2584]](fatih/vim-go#2584)
  [[GH-2597]](fatih/vim-go#2597)
  [[GH-2599]](fatih/vim-go#2599)
* Add highlighting of sections reported by gopls diagnostics' errors
  and warnings.
  [[GH-2569]](fatih/vim-go#2569)
  [[GH-2643]](fatih/vim-go#2643)
* Make the highlighting of fzf decls configurable.
  [[GH-2572]](fatih/vim-go#2572)
  [[GH-2579]](fatih/vim-go#2579)
* Support renaming with gopls.
  [[GH-2577]](fatih/vim-go#2577)
  [[GH-2618]](fatih/vim-go#2618)
* Add an option, `g:go_gopls_enabled`, to allow gopls integration to be
  disabled.
  [[GH-2605]](fatih/vim-go#2605)
  [[GH-2609]](fatih/vim-go#2609)
  [[GH-2638]](fatih/vim-go#2638)
  [[GH-2640]](fatih/vim-go#2640)
* Add a buffer level option, `b:go_fmt_options`, to control formatting options
  per buffer.
  [[GH-2613]](fatih/vim-go#2613)
* Use build tags when running `:GoVet`.
  [[GH-2615]](fatih/vim-go#2615)
* Add new snippets for UltiSnips.
  [[GH-2623]](fatih/vim-go#2623)
  [[GH-2627]](fatih/vim-go#2627)
* Expand completions as snippets when `g:go_gopls_use_placeholders` is set.
  [[GH-2624]](fatih/vim-go#2624)
* Add a new function, `:GoDiagnostics` and an associated mapping for seeing
  `gopls` diagnostics. Because of the performance implications on large
  projects, `g:go_diagnostics_enabled` controls whether all diagnostics are
  processed or only the diagnostics for the current buffer.
  [[GH-2612]](fatih/vim-go#2612)
* Explain how to find and detect multiple copies of vim-go in the FAQ.
  [[GH-2632]](fatih/vim-go#2632)
* Update the issue template to ask for the gopls version and
  `:GoReportGitHubIssue` to provide it.
  [[GH-2630]](fatih/vim-go#2630)
* Use text properties when possible for some highlighting cases.
  [[GH-2652]](fatih/vim-go#2652)
  [[GH-2662]](fatih/vim-go#2662)
  [[GH-2663]](fatih/vim-go#2663)
  [[GH-2672]](fatih/vim-go#2672)
  [[GH-2678]](fatih/vim-go#2678)

BUG FIXES:
* Fix removal of missing directories from gopls workspaces.
  [[GH-2507]](fatih/vim-go#2507)
* Change to original window before trying to change directories when term job
  ends.
  [[GH-2508]](fatih/vim-go#2508)
* Swallow errors when the hover info cannot be determined.
  [[GH-2515]](fatih/vim-go#2515)
* Fix errors when trying to debug lsp and hover.
  [[GH-2516]](fatih/vim-go#2516)
* Reset environment variables on Vim <= 8.0.1831 .
  [[GH-2523]](fatih/vim-go#2523)
* Handle empty results from delve.
  [[GH-2526]](fatih/vim-go#2526)
* Do not overwrite `updatetime` when `g:go_auto_sameids` or
  `g:go_auto_type_info` is set.
  [[GH-2529]](fatih/vim-go#2529)
* Fix example for `g:go_debug_log_output` in docs.
  [[GH-2547]](fatih/vim-go#2547)
* Use FileChangedShellPost instead of FileChangedShell so that reload messages
  are not hidden.
  [[GH-2549]](fatih/vim-go#2549)
* Restore cwd after `:GoTest` when `g:go_term_enabled` is set.
  [[GH-2556]](fatih/vim-go#2556)
* Expand struct variable correctly in the variables debug window.
  [[GH-2574]](fatih/vim-go#2574)
* Show output from errcheck when there are failures other than problems it can
  report.
  [[GH-2667]](fatih/vim-go#2667)

Signed-off-by: Patrick McCarty <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bhcleek bhcleek bhcleek left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
vim-go 1.22
Development

Successfully merging this pull request may close these issues.
2 participants
@delphinus @bhcleek