Skip to content

Commit 2409c8b

Browse files
committed
CLEAN: Specifically document options arguments.
1 parent 5a6b430 commit 2409c8b

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

prolog/dot.pl

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161

6262

6363
%! dot_arc(+Out:stream, +FromTerm:term, +ToTerm:term) is det.
64-
%! dot_arc(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:dict) is det.
64+
%! dot_arc(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:options) is det.
6565
%
6666
% Emits an arc (directed edge) from one Prolog term to another in the
6767
% DOT language.
@@ -87,7 +87,7 @@
8787

8888

8989
%! dot_arc_id(+Out:stream, +FromId:atom, +ToId:atom) is det.
90-
%! dot_arc_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:dict) is det.
90+
%! dot_arc_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:options) is det.
9191
%
9292
% Emits a directed edge or arc from one DOT ID to another in the DOT
9393
% language.
@@ -137,7 +137,7 @@
137137

138138

139139

140-
%! dot_attributes(+Options:dict, -String:string) is det.
140+
%! dot_attributes(+Options:options, -String:string) is det.
141141

142142
dot_attributes(options{}, "") :- !.
143143
dot_attributes(Options, String) :-
@@ -156,7 +156,7 @@
156156

157157

158158
%! dot_cluster(+Out:stream, +Term:term, :Goal_1) is det.
159-
%! dot_cluster(+Out:stream, +Term:term, :Goal_1, +Options:dict) is det.
159+
%! dot_cluster(+Out:stream, +Term:term, :Goal_1, +Options:options) is det.
160160

161161
dot_cluster(Out, Term, Goal_1) :-
162162
dot_cluster(Out, Term, Goal_1, options{label: Term}).
@@ -169,7 +169,7 @@
169169

170170

171171
%! dot_cluster_arc(+Out:stream, +FromTerm:term, +ToTerm:term) is det.
172-
%! dot_cluster_arc(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:dict) is det.
172+
%! dot_cluster_arc(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:options) is det.
173173

174174
dot_cluster_arc(Out, FromTerm, ToTerm) :-
175175
dot_cluster_arc(Out, FromTerm, ToTerm, options{}).
@@ -182,7 +182,7 @@
182182

183183

184184
%! dot_cluster_arc_id(+Out:stream, +FromId:atom, +ToId:atom) is det.
185-
%! dot_cluster_arc_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:dict) is det.
185+
%! dot_cluster_arc_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:options) is det.
186186

187187
dot_cluster_arc_id(Out, FromId, ToId) :-
188188
dot_cluster_arc_id(Out, FromId, ToId, options{}).
@@ -197,7 +197,7 @@
197197

198198

199199
%! dot_cluster_id(+Out:stream, +Id:atom, :Goal_1) is det.
200-
%! dot_cluster_id(+Out:stream, +Id:atom, :Goal_1, +Options:dict) is det.
200+
%! dot_cluster_id(+Out:stream, +Id:atom, :Goal_1, +Options:options) is det.
201201

202202
dot_cluster_id(Out, Id, Goal_1) :-
203203
dot_cluster_id(Out, Id, Goal_1, options{}).
@@ -214,7 +214,7 @@
214214

215215

216216
%! dot_edge(+Out:stream, +FromTerm:term, +ToTerm:term) is det.
217-
%! dot_edge(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:dict) is det.
217+
%! dot_edge(+Out:stream, +FromTerm:term, +ToTerm:term, +Options:options) is det.
218218
%
219219
% Emits an edge between two Prolog terms in the DOT language.
220220
%
@@ -240,7 +240,7 @@
240240

241241

242242
%! dot_edge_id(+Out:stream, +FromId:atom, +ToId:atom) is det.
243-
%! dot_edge_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:dict) is det.
243+
%! dot_edge_id(+Out:stream, +FromId:atom, +ToId:atom, +Options:options) is det.
244244
%
245245
% Emits an edge between two DOT IDs in the DOT language.
246246
%
@@ -257,7 +257,7 @@
257257

258258

259259
%! dot_graph(+Out:stream, :Goal_1) is det.
260-
%! dot_graph(+Out:stream, :Goal_1, +Options:dict) is det.
260+
%! dot_graph(+Out:stream, :Goal_1, +Options:options) is det.
261261
%
262262
% @arg Options The following options are supported:
263263
%
@@ -374,7 +374,7 @@
374374

375375

376376
%! dot_node(+Out:stream, +Term:term) is det.
377-
%! dot_node(+Out:stream, +Term:term, +Options:dict) is det.
377+
%! dot_node(+Out:stream, +Term:term, +Options:options) is det.
378378
%
379379
% @arg Out is a handle to an output stream.
380380
%
@@ -413,7 +413,7 @@
413413

414414

415415
%! dot_node_id(+Out:stream, +Id:atom) is det.
416-
%! dot_node_id(+Out:stream, +Id:atom, +Options:dict) is det.
416+
%! dot_node_id(+Out:stream, +Id:atom, +Options:options) is det.
417417
%
418418
% @see dot_node/[2,3] allows nodes to be asserted for Prolog terms.
419419

prolog/gv.pl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
% EXPORT/VIEW %
5454

5555
%! gv_export(+File:atom, :Goal_1) is det.
56-
%! gv_export(+File:atom, :Goal_1, +Options:dict) is det.
56+
%! gv_export(+File:atom, :Goal_1, +Options:options) is det.
5757
%
5858
% @arg File is the name of the file to which the graph export is
5959
% written.
@@ -106,7 +106,7 @@
106106
%! -Format:gv_format,
107107
%! -Type:gv_type,
108108
%! -Method:gv_method,
109-
%! -Options:dict) is det.
109+
%! -Options:options) is det.
110110

111111
gv_options_(Options0, DefaultFormat, Format, Type, Method, Options3) :-
112112
% Set default option values.
@@ -150,7 +150,7 @@
150150

151151

152152
%! gv_view(:Goal_1) is det.
153-
%! gv_view(:Goal_1, +Options:dict) is det.
153+
%! gv_view(:Goal_1, +Options:options) is det.
154154
%
155155
% Generate a GraphViz graph visualization and open the result in a
156156
% viewer application.

0 commit comments

Comments
 (0)