Skip to content

Commit e4b3baa

Browse files
author
github-actions
committed
[docgen] Update doc/orgmode_api.txt
1 parent 13091bc commit e4b3baa

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

doc/orgmode_api.txt

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,11 @@ OrgFile:reload() *OrgFile:reload*
3333
OrgHeadline *OrgHeadline*
3434

3535
Fields: ~
36-
{title} (string) headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline :SOMETAG:` returns `I am a headline`
37-
{line} (string) full headline line
38-
{tags} (string[]) List of own tags
39-
{deadline} (Date|nil)
40-
{scheduled} (Date|nil)
41-
{closed} (Date|nil)
42-
{dates} (Date[]) List of all dates that are not "plan" dates
43-
{position} (Range)
44-
{all_tags} (string[]) List of all tags (own + inherited)
45-
{file} (OrgFile)
46-
{parent} (OrgHeadline|nil)
47-
{priority} (string|nil)
48-
{headlines} (OrgHeadline[])
36+
{title} (string) headline title without todo keyword, tags and priority. Ex. `* TODO I am a headline :SOMETAG:` returns `I am a headline`
37+
{line} (string) full headline line
38+
{level} (number) headline level (number of asterisks). Example: 1
39+
{todo_value?} (string) todo keyword of the headline (Example: TODO, DONE)
40+
{todo_type?} (string|)
4941

5042

5143
OrgHeadline:reload() *OrgHeadline:reload*
@@ -120,32 +112,38 @@ OrgAgendaFilter *OrgAgendaFilter*
120112

121113
OrgAgendaOptions *OrgAgendaOptions*
122114

115+
Fields: ~
116+
{filters?} (OrgAgendaFilter)
117+
{from?} (string|Date)
118+
{span?} (number|day|week|month|year)
119+
123120

124121
OrgAgenda.agenda({options?}) *OrgAgenda.agenda*
125-
@field filters? OrgAgendaFilter
126-
@field from? string | Date
127-
@field span? number | 'day' | 'week' | 'month' | 'year'
128122

129123
Parameters: ~
130124
{options?} (OrgAgendaOptions)
131125

132126

133127
OrgAgendaTodosOptions *OrgAgendaTodosOptions*
134128

129+
Fields: ~
130+
{filters?} (OrgAgendaFilter)
131+
135132

136133
OrgAgenda.todos({options?}) *OrgAgenda.todos*
137-
@field filters? OrgAgendaFilter
138134

139135
Parameters: ~
140136
{options?} (OrgAgendaTodosOptions)
141137

142138

143139
OrgAgendaTagsOptions *OrgAgendaTagsOptions*
144140

141+
Fields: ~
142+
{filters?} (OrgAgendaFilter)
143+
{todo_only?} (boolean)
144+
145145

146146
OrgAgenda.tags({options?}) *OrgAgenda.tags*
147-
@field filters? OrgAgendaFilter
148-
@field todo_only? boolean
149147

150148
Parameters: ~
151149
{options?} (OrgAgendaTagsOptions)

0 commit comments

Comments
 (0)