code review 7757043: misc/vim: ':Godoc' command does not work with 'log.Print'

misc/vim: ':Godoc' command does not work with 'log.Print'

[mattn, 2013-03-12 17:26:20]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[adg, 2013-03-12 23:52:18]

Can you explain the problem better? What is it that doesn't work?


On 13 March 2013 04:26, <mattn.jp@gmail.com> wrote:

> Reviewers: golang-dev1,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> misc/vim: ':Godoc' command does not work with 'log.Print'
>
> Please review this at
https://codereview.appspot.**com/7757043/<https://codereview.appspot.com/7757...
>
> Affected files:
>   M misc/vim/plugin/godoc.vim
>
>
> Index: misc/vim/plugin/godoc.vim
> ==============================**==============================**=======
> --- a/misc/vim/plugin/godoc.vim
> +++ b/misc/vim/plugin/godoc.vim
> @@ -70,13 +70,19 @@
>  function! s:Godoc(...)
>    let word = join(a:000, ' ')
>    if !len(word)
> -    let word = expand('<cword>')
> +    let word = expand('<cWORD>')
>    endif
>    let word = substitute(word, '[^a-zA-Z0-9\\/._~-]', '', 'g')
> -  if !len(word)
> +  let words = split(word, '\.')
> +  if !len(words)
>      return
>    endif
> -  call s:GodocWord(word)
> +  call s:GodocWord(words[0])
> +  if len(words) > 1
> +    if search('^func ' . words[1]) == 0
> +      echo 'No documentation found for "' . word . '".'
> +    endif
> +  endif
>  endfunction
>
>  command! -nargs=* -range -complete=customlist,go#**complete#Package
> Godoc :call s:Godoc(<q-args>)
>
>
> --
>
> ---You received this message because you are subscribed to the Google
> Groups "golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to
golang-dev+unsubscribe@**googlegroups.com<golang-dev%2Bunsubscribe@googlegrou...
> .
> For more options, visit
https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/o...
> .
>
>
>

[mattn, 2013-03-13 07:03:14]

> Can you explain the problem better? What is it that doesn't work?

ex:
-----------
  log.Print(strings.TrimSpace(""))
-----------

When cursor is on strings.TrimSpace, :Godoc have better to show doc of strings
and find the part of TrimSpace. And When cursor is on "log.Print", it have
better to show doc of "log.Print".

[adg, 2013-03-13 22:44:18]

R=dsymonds, who knows vim script

[dsymonds, 2013-03-18 03:07:52]

sorry for the delay

https://codereview.appspot.com/7757043/diff/20001/misc/vim/ftdetect/gofiletyp...
File misc/vim/ftdetect/gofiletype.vim (right):

https://codereview.appspot.com/7757043/diff/20001/misc/vim/ftdetect/gofiletyp...
misc/vim/ftdetect/gofiletype.vim:12: setlocal filetype=go iskeyword+=.
I don't think we should be automatically setting iskeyword. That has too much
fallout for all the commands it affects. If you think it's really important for
it to work here, I'd prefer adding a mention of it to the readme instead.

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim
File misc/vim/plugin/godoc.vim (right):

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim#n...
misc/vim/plugin/godoc.vim:76: let words = split(word, '\.')
line 75 is removing dots. How is this line going to result in anything other
than exactly one item?

[mattn, 2013-03-25 11:21:04]

Sorry for delay

https://codereview.appspot.com/7757043/diff/20001/misc/vim/ftdetect/gofiletyp...
File misc/vim/ftdetect/gofiletype.vim (right):

https://codereview.appspot.com/7757043/diff/20001/misc/vim/ftdetect/gofiletyp...
misc/vim/ftdetect/gofiletype.vim:12: setlocal filetype=go iskeyword+=.
On 2013/03/18 03:07:52, dsymonds wrote:
> I don't think we should be automatically setting iskeyword. That has too much
> fallout for all the commands it affects. If you think it's really important
for
> it to work here, I'd prefer adding a mention of it to the readme instead.

I removed this change. And hack to modify iskeyword temporary.

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim
File misc/vim/plugin/godoc.vim (right):

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim#n...
misc/vim/plugin/godoc.vim:76: let words = split(word, '\.')
On 2013/03/18 03:07:52, dsymonds wrote:
> line 75 is removing dots. How is this line going to result in anything other
> than exactly one item?

This change works as following for "log.Print".

1. Open doc of "log"
2. Find line of "Print"

[dsymonds, 2013-03-26 03:17:28]

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim
File misc/vim/plugin/godoc.vim (right):

https://codereview.appspot.com/7757043/diff/20001/misc/vim/plugin/godoc.vim#n...
misc/vim/plugin/godoc.vim:76: let words = split(word, '\.')
On 2013/03/25 11:21:04, mattn wrote:
> On 2013/03/18 03:07:52, dsymonds wrote:
> > line 75 is removing dots. How is this line going to result in anything other
> > than exactly one item?
> 
> This change works as following for "log.Print".
> 
> 1. Open doc of "log"
> 2. Find line of "Print"

Aah, I missed the ^ at the start of the character class. So the previous line is
*not* removing dots. That makes more sense.

https://codereview.appspot.com/7757043/diff/26001/misc/vim/plugin/godoc.vim
File misc/vim/plugin/godoc.vim (right):

https://codereview.appspot.com/7757043/diff/26001/misc/vim/plugin/godoc.vim#n...
misc/vim/plugin/godoc.vim:91: echo 'No documentation found for "' . word . '".'
You've got const, var, func covered, but not type.

[mattn, 2013-03-26 06:36:23]

https://codereview.appspot.com/7757043/diff/26001/misc/vim/plugin/godoc.vim
File misc/vim/plugin/godoc.vim (right):

https://codereview.appspot.com/7757043/diff/26001/misc/vim/plugin/godoc.vim#n...
misc/vim/plugin/godoc.vim:91: echo 'No documentation found for "' . word . '".'
On 2013/03/26 03:17:28, dsymonds wrote:
> You've got const, var, func covered, but not type.

Done.

[dsymonds, 2013-03-26 06:38:42]

LGTM

[dsymonds, 2013-03-26 06:40:00]

*** Submitted as https://code.google.com/p/go/source/detail?r=319d13f7fda0 ***

misc/vim: make Godoc command work with "log.Print".

R=dsymonds
CC=golang-dev
https://codereview.appspot.com/7757043

Committer: David Symonds <dsymonds@golang.org>