search

SWI-Prolog / packages-http

The SWI-Prolog HTTP server and client libraries
23 stars 23 forks source link

Confusing exports and documentation of http_reply and http_status_reply #152

Open spl opened 2 years ago

spl commented 2 years ago

There are a number of inconsistencies between what's exported, what's documented for the predicate, and what's actually defined for http_reply and http_status_reply in http_header.pl.

Also, note that Status is mentioned in the docs for http_reply but doesn't show up in the documentation.

% Exports
http_reply/2,  % +What, +Stream
http_reply/3,  % +What, +Stream, +HdrExtra
http_reply/4,  % +What, +Stream, +HdrExtra, -Code
http_reply/5,  % +What, +Stream, +HdrExtra, +Context, -Code
http_reply/6,  % +What, +Stream, +HdrExtra, +Context, +Request, -Code
% Docs
%!  http_reply(+Data, +Out:stream) is det.
%!  http_reply(+Data, +Out:stream, +HdrExtra) is det.
%!  http_reply(+Data, +Out:stream, +HdrExtra, -Code) is det.
%!  http_reply(+Data, +Out:stream, +HdrExtra, +Context, -Code) is det.
%!  http_reply(+Data, +Out:stream, +HdrExtra, +Context, +Request, -Code) is det.
% Predicates
http_reply(What, Out) :-
http_reply(Data, Out, HdrExtra) :-
http_reply(Data, Out, HdrExtra, Code) :-
http_reply(Data, Out, HdrExtra, Context, Code) :-
http_reply(Data, Out, HdrExtra, _Context, Request, Code) :-
http_reply(Status, Out, HdrExtra, Context, Request, Code) :-
% Exports
http_status_reply/4,  % +Status, +Out, +HdrExtra, -Code
http_status_reply/5,  % +Status, +Out, +HdrExtra, +Context, -Code
% Docs
%!  http_status_reply(+Status, +Out, +HdrExtra, -Code) is det.
%!  http_status_reply(+Status, +Out, +HdrExtra, +Context, -Code) is det.
%!  http_status_reply(+Status, +Out, +HdrExtra, +Context, +Request, -Code) is det.
% Predicates
http_status_reply(Status, Out, Options) :-
http_status_reply(Status, Out, HdrExtra, Code) :-
http_status_reply(Status, Out, HdrExtra, Context, Code) :-
http_status_reply(Status, Out, HdrExtra, Context, Request, Code) :-