[vim/vim] Fix document index.txt and windows.txt (PR #16357)
h_east
Related: #16356
Modified documentation based on results of running "$ make check_doc" with improved generator script.
Regarding the notation of shortened commands, index.txt has been corrected all. However, for other documents, only the ones that were obviously incorrect have been corrected.
Corrected:
:hor[izontal]--->:ho[rizontal]:pta[g]--->:pt[ag]
Not corrected (for example):
:bufdo--->:bufd[o]:eval--->:ev[al]
Reasons for not correcting:
- Vim9 script is moving in a direction away from shortening. (
:h vim9-no-shorten) - When written as
:ev[al], people's psychology dictates that they will shorten the command.
There may be room for discuss, but I would like to proceed in this direction.
--Best regards,
Hirohito Higashi (h_east)
You can view, comment on, or merge this pull request online at:
https://github.com/vim/vim/pull/16357
Commit Summary
- 4162b17 Fix document index.txt and windows.txt
File Changes
(3 files)
- M runtime/doc/index.txt (27)
- M runtime/doc/tags (4)
- M runtime/doc/windows.txt (8)
Patch Links:
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
@zzzyxwvut commented on this pull request.
> @@ -1185,6 +1185,7 @@ tag command action ~ |:abbreviate| :ab[breviate] enter abbreviation |:abclear| :abc[lear] remove all abbreviations |:aboveleft| :abo[veleft] make split window appear left or above +|:abstract| :abstract define a Vim9 abstract class⬇️ Suggested change
-|:abstract| :abstract define a Vim9 abstract class +|:abstract| :abstract declare an abstract class
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
> @@ -1338,12 +1339,15 @@ tag command action ~ |:emenu| :em[enu] execute a menu by name |:endclass| :endclass end of a class specification |:enddef| :enddef end of a user function started with :def +|:endenum| :endenum end of a enum specification⬇️ Suggested change
-|:endenum| :endenum end of a enum specification +|:endenum| :endenum end of an enum specification
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
> |:endfor| :endfo[r] end previous :for |:endfunction| :endf[unction] end of a user function started with :function |:endtry| :endt[ry] end previous :try |:endwhile| :endw[hile] end previous :while |:enew| :ene[w] edit a new, unnamed buffer +|:enum| :enum start of a enum specification⬇️ Suggested change
-|:enum| :enum start of a enum specification +|:enum| :enum start of an enum specification
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
> @@ -1706,6 +1711,7 @@ tag command action ~ |:terminal| :ter[minal] open a terminal window |:tfirst| :tf[irst] jump to first matching tag |:throw| :th[row] throw an exception +|:this| :this prefix for an object member
this is a reference to an object instantiated with new();
this reference is only permitted in the bodies of instance
methods, constructors, and instance variable initializers
(with some further restrictions, see #14411).
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
Aliaksei Budavei
I would've rather used ‘declaration’ throughout for every
‘specification’. Since we have incomplete types that are
introduced with either :interface or :abstract class and
complete types (classes and enums); we can use an umbrella
term ‘declaration’ for either. There is also an undeveloped
‘specifies’ concept (#15440) that may further complicate
type-related terminology in the future.
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.
h_east
Thanks for reviewing.
Most of the explanations for the added lines are copied from doc/version9.txt.
:h added-9.1 /:abs
If you are concerned, you can modify the original descriptions.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
h_east
@h-east pushed 1 commit.
- 0086e3b Update runtime/doc/index.txt
—
View it on GitHub or unsubscribe.
You are receiving this because you are subscribed to this thread.
Christian Brabandt
Thanks, I'll also update it with @zzzyxwvut suggestions.
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
zeertzjq
:ho doesn't work for parse_command_modifiers():
case 'h': if (checkforcmd_noparen(&eap->cmd, "horizontal", 3)) { cmod->cmod_split |= WSP_HOR; continue; }
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
Christian Brabandt
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
h_east
@zeertzjq Oops, I'll fix this. new PR?
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.
h_east
PRed. #16362
—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.