Skip to content

Commit 3d4585e

Browse files
committed
doc: small documentation tweaks
1 parent 96e2ce6 commit 3d4585e

File tree

4 files changed

+32
-18
lines changed

4 files changed

+32
-18
lines changed

doc/oil.txt

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ toggle_trash *actions.toggle_tras
409409
HIGHLIGHTS *oil-highlights*
410410

411411
OilDir *hl-OilDir*
412-
Directories in an oil buffer
412+
Directory names in an oil buffer
413413

414414
OilDirIcon *hl-OilDirIcon*
415415
Icon for directories
@@ -442,13 +442,14 @@ OilChange *hl-OilChang
442442
Change action in the oil preview window
443443

444444
OilRestore *hl-OilRestore*
445-
Restore a file from trash
445+
Restore (from the trash) action in the oil preview window
446446

447447
OilPurge *hl-OilPurge*
448-
Permanently delete a file from trash
448+
Purge (Permanently delete a file from trash) action in the oil preview
449+
window
449450

450451
OilTrash *hl-OilTrash*
451-
Delete a file to the trash
452+
Trash (delete a file to trash) action in the oil preview window
452453

453454
OilTrashSourcePath *hl-OilTrashSourcePath*
454455
Virtual text that shows the original path of file in the trash
@@ -474,11 +475,11 @@ Linux:
474475

475476
Mac:
476477
Oil has limited support for MacOS due to the proprietary nature of the
477-
implementation. The trash bin can only be viewed as single dir
478+
implementation. The trash bin can only be viewed as a single dir
478479
(instead of being able to see files that were trashed from a directory).
479480

480481
Windows:
481-
Oil does not yet support the Windows trash.
482+
Oil does not yet support the Windows trash. PRs are welcome!
482483

483484
================================================================================
484485
vim:tw=80:ts=2:ft=help:norl:syntax=help:

lua/oil/adapters/trash/freedesktop.lua

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
-- Based on the FreeDesktop.org trash specification
22
-- https://specifications.freedesktop.org/trash-spec/trashspec-1.0.html
3-
-- TODO
4-
-- * make sure that the subdirs for trash use the same entry as the root
3+
-- TODO make sure that the subdirs for trash use the same entry as the root
54
local cache = require("oil.cache")
65
local config = require("oil.config")
76
local constants = require("oil.constants")

lua/oil/init.lua

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ M._get_highlights = function()
628628
{
629629
name = "OilDir",
630630
link = "Directory",
631-
desc = "Directories in an oil buffer",
631+
desc = "Directory names in an oil buffer",
632632
},
633633
{
634634
name = "OilDirIcon",
@@ -683,17 +683,17 @@ M._get_highlights = function()
683683
{
684684
name = "OilRestore",
685685
link = "OilCreate",
686-
desc = "Restore a file from trash",
686+
desc = "Restore (from the trash) action in the oil preview window",
687687
},
688688
{
689689
name = "OilPurge",
690690
link = "OilDelete",
691-
desc = "Permanently delete a file from trash",
691+
desc = "Purge (Permanently delete a file from trash) action in the oil preview window",
692692
},
693693
{
694694
name = "OilTrash",
695695
link = "OilDelete",
696-
desc = "Delete a file to the trash",
696+
desc = "Trash (delete a file to trash) action in the oil preview window",
697697
},
698698
{
699699
name = "OilTrashSourcePath",

scripts/generate.py

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -136,15 +136,29 @@ class ColumnDef:
136136
),
137137
ColumnDef("size", "files, ssh", False, True, "The size of the file", HL + []),
138138
ColumnDef(
139-
"permissions", "files, ssh", True, False, "Access permissions of the file", HL + []
139+
"permissions",
140+
"files, ssh",
141+
True,
142+
False,
143+
"Access permissions of the file",
144+
HL + [],
145+
),
146+
ColumnDef(
147+
"ctime", "files", False, True, "Change timestamp of the file", HL + TIME + []
140148
),
141-
ColumnDef("ctime", "files", False, True, "Change timestamp of the file", HL + TIME + []),
142149
ColumnDef(
143150
"mtime", "files", False, True, "Last modified time of the file", HL + TIME + []
144151
),
145-
ColumnDef("atime", "files", False, True, "Last access time of the file", HL + TIME + []),
146152
ColumnDef(
147-
"birthtime", "files", False, True, "The time the file was created", HL + TIME + []
153+
"atime", "files", False, True, "Last access time of the file", HL + TIME + []
154+
),
155+
ColumnDef(
156+
"birthtime",
157+
"files",
158+
False,
159+
True,
160+
"The time the file was created",
161+
HL + TIME + [],
148162
),
149163
]
150164

@@ -239,11 +253,11 @@ def get_trash_vimdoc() -> "VimdocSection":
239253
240254
Mac:
241255
Oil has limited support for MacOS due to the proprietary nature of the
242-
implementation. The trash bin can only be viewed as single dir
256+
implementation. The trash bin can only be viewed as a single dir
243257
(instead of being able to see files that were trashed from a directory).
244258
245259
Windows:
246-
Oil does not yet support the Windows trash.
260+
Oil does not yet support the Windows trash. PRs are welcome!
247261
"""
248262
)
249263
return section

0 commit comments

Comments
 (0)